Compile-time configuration options for emCute, an implementation of the OASIS MQTT-SN protocol for RIOT. More...

Detailed Description

Compile-time configuration options for emCute, an implementation of the OASIS MQTT-SN protocol for RIOT.

It is designed with a focus on small memory footprint and usability

Macros
#define	CONFIG_EMCUTE_DEFAULT_PORT (1883U)
	Default UDP port to listen on (also used as SRC port).

#define	CONFIG_EMCUTE_BUFSIZE (512U)
	Buffer size used for emCute's transmit and receive buffers.

#define	CONFIG_EMCUTE_TOPIC_MAXLEN (196U)
	Maximum topic length.

#define	CONFIG_EMCUTE_KEEPALIVE (360) /* -> 6 min*/
	Keep-alive interval [in seconds] communicated to the gateway.

#define	CONFIG_EMCUTE_T_RETRY (15U) /* -> 15 sec */
	Re-send interval [in seconds].

#define	CONFIG_EMCUTE_N_RETRY (3U)
	Number of retransmissions until requests time out.

Macro Definition Documentation

◆ CONFIG_EMCUTE_BUFSIZE

#define CONFIG_EMCUTE_BUFSIZE (512U)

Buffer size used for emCute's transmit and receive buffers.

Note: The buffer size MUST be less than 32768 on 16-bit and 8-bit platforms to prevent buffer overflows.

The overall buffer size used by emCute is this value time two (Rx + Tx).

Definition at line 125 of file emcute.h.

◆ CONFIG_EMCUTE_DEFAULT_PORT

#define CONFIG_EMCUTE_DEFAULT_PORT (1883U)

Default UDP port to listen on (also used as SRC port).

Usage can be found in examples/emcute_mqttsn. Application code is expected to use this macro to assign the default port.

Definition at line 113 of file emcute.h.

◆ CONFIG_EMCUTE_KEEPALIVE

#define CONFIG_EMCUTE_KEEPALIVE (360) /* -> 6 min*/

Keep-alive interval [in seconds] communicated to the gateway.

Keep alive interval in seconds which is communicated to the gateway in the CONNECT message. For more information, see MQTT-SN Spec v1.2, section 5.4.4. For default values, see section 7.2 -> TWAIT: > 5 min.

Definition at line 145 of file emcute.h.

◆ CONFIG_EMCUTE_N_RETRY

#define CONFIG_EMCUTE_N_RETRY (3U)

Number of retransmissions until requests time out.

Maximum number of retransmissions in the event that the retry timer times out. After 'CONFIG_EMCUTE_N_RETRY' number of retransmissions, the client aborts the procedure and assumes that its MQTT-SN connection to the gateway is disconnected. For more information, see MQTT-SN Spec v1.2, section 6.13. For default values, see section 7.2 -> Nretry: 3-5.

Definition at line 172 of file emcute.h.

◆ CONFIG_EMCUTE_T_RETRY

#define CONFIG_EMCUTE_T_RETRY (15U) /* -> 15 sec */

Re-send interval [in seconds].

Interval used for timing the retry messages which are sent when the expected reply from GW is not received. The retry timer is started by the client when the message is sent and stopped when the expected reply from GW is received. If the timer times out and the expected GW’s reply is not received, the client retransmits the message. For more information, see MQTT-SN Spec v1.2, section 6.13. For default values, see section 7.2 -> Tretry: 10 to 15 sec.

Definition at line 159 of file emcute.h.

◆ CONFIG_EMCUTE_TOPIC_MAXLEN

#define CONFIG_EMCUTE_TOPIC_MAXLEN (196U)

Maximum topic length.

Note: Must be less than (256 - 6) AND less than ( CONFIG_EMCUTE_BUFSIZE - 6 )

Definition at line 134 of file emcute.h.