Skip to content

Commit e0988e6

Browse files
mfalkviddhenrikekblad
authored andcommitted
Add more missing keywords (#1111)
This fixes #1089 and also adds Doxygen and syntax highlighting for the following keywords: MY_GATEWAY_MQTT_CLIENT MY_GATEWAY_SERIAL MY_IP_GATEWAY_ADDRESS MY_IP_SUBNET_ADDRESS MY_MQTT_CLIENT_ID MY_MQTT_PUBLISH_TOPIC_PREFIX MY_MQTT_SUBSCRIBE_TOPIC_PREFIX
1 parent a842986 commit e0988e6

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

MyConfig.h

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1350,6 +1350,10 @@
13501350
* @brief Define this for Ethernet GW based on Linux.
13511351
* @def MY_GATEWAY_TINYGSM
13521352
* @brief Define this for Ethernet GW based on GSM modems supported by TinyGSM library.
1353+
* @def MY_GATEWAY_MQTT_CLIENT
1354+
* @brief Define this for MQTT client GW.
1355+
* @def MY_GATEWAY_SERIAL
1356+
* @brief Define this for Serial GW.
13531357
*/
13541358
// The gateway options available
13551359
//#define MY_GATEWAY_W5100
@@ -1358,6 +1362,8 @@
13581362
//#define MY_GATEWAY_ESP32
13591363
//#define MY_GATEWAY_LINUX
13601364
//#define MY_GATEWAY_TINYGSM
1365+
//#define MY_GATEWAY_MQTT_CLIENT
1366+
//#define MY_GATEWAY_SERIAL
13611367

13621368

13631369
/**
@@ -1404,6 +1410,33 @@
14041410
*/
14051411
//#define MY_MQTT_USER "username"
14061412

1413+
/**
1414+
* @def MY_MQTT_CLIENT_ID
1415+
* @brief Set client ID for MQTT connections
1416+
*
1417+
* This define is mandatory for all MQTT client gateways.
1418+
* Example: @code #define MY_MQTT_CLIENT_ID "mysensors-1" @endcode
1419+
*/
1420+
//#define MY_MQTT_CLIENT_ID "mysensors-1"
1421+
1422+
/**
1423+
* @def MY_MQTT_PUBLISH_TOPIC_PREFIX
1424+
* @brief Set prefix for MQTT topic to publish to.
1425+
*
1426+
* This define is mandatory for all MQTT client gateways.
1427+
* Example: @code #define MY_MQTT_PUBLISH_TOPIC_PREFIX "mygateway1-out" @endcode
1428+
*/
1429+
//#define MY_MQTT_PUBLISH_TOPIC_PREFIX "mygateway1-out"
1430+
1431+
/**
1432+
* @def MY_MQTT_SUBSCRIBE_TOPIC_PREFIX
1433+
* @brief Set prefix for MQTT topic to subscribe to.
1434+
*
1435+
* This define is mandatory for all MQTT client gateways.
1436+
* Example: @code #define MY_MQTT_SUBSCRIBE_TOPIC_PREFIX "mygateway1-in" @endcode
1437+
*/
1438+
//#define MY_MQTT_SUBSCRIBE_TOPIC_PREFIX "mygateway1-in"
1439+
14071440
/**
14081441
* @def MY_IP_ADDRESS
14091442
* @brief Static ip address of gateway. If not defined, DHCP will be used.
@@ -1412,6 +1445,22 @@
14121445
*/
14131446
//#define MY_IP_ADDRESS 192,168,178,66
14141447

1448+
/**
1449+
* @def MY_IP_GATEWAY_ADDRESS
1450+
* @brief IP address of your broadband router/gateway, if not using DHCP.
1451+
*
1452+
* Example: @code #define MY_IP_GATEWAY_ADDRESS 192,168,1,1 @endcode
1453+
*/
1454+
//#define MY_IP_GATEWAY_ADDRESS 192,168,1,1
1455+
1456+
/**
1457+
* @def MY_IP_SUBNET_ADDRESS
1458+
* @brief Subnet address of your local network, if not using DHCP.
1459+
*
1460+
* Example: @code #define MY_IP_SUBNET_ADDRESS 255,255,255,0 @endcode
1461+
*/
1462+
//#define MY_IP_SUBNET_ADDRESS 255,255,255,0
1463+
14151464
/**
14161465
* @def MY_USE_UDP
14171466
* @brief Enables UDP mode for Ethernet gateway.
@@ -1444,8 +1493,22 @@
14441493
* Example: @code #define MY_CONTROLLER_IP_ADDRESS 192,168,178,254 @endcode
14451494
*
14461495
* If left un-defined, gateway acts as server allowing incoming connections.
1496+
* @see MY_CONTROLLER_URL_ADDRESS
14471497
*/
14481498
//#define MY_CONTROLLER_IP_ADDRESS 192,168,178,254
1499+
1500+
/**
1501+
* @def MY_CONTROLLER_URL_ADDRESS
1502+
* @brief If this is defined, gateway will act as a client (ethernet or MQTT) trying to
1503+
* contact controller on the given URL.
1504+
*
1505+
* If left un-defined, gateway acts as server allowing incoming connections.
1506+
* Example: @code #define MY_CONTROLLER_URL_ADDRESS "test.mosquitto.org" @endcode
1507+
* @see MY_CONTROLLER_IP_ADDRESS
1508+
* @see MY_GATEWAY_MQTT_CLIENT
1509+
*/
1510+
//#define MY_CONTROLLER_URL_ADDRESS "test.mosquitto.org"
1511+
14491512
/** @}*/ // End of GatewaySettingGrpPub group
14501513

14511514
/**
@@ -2089,6 +2152,9 @@
20892152
#define MY_MQTT_CLIENT_PUBLISH_RETAIN
20902153
#define MY_MQTT_PASSWORD
20912154
#define MY_MQTT_USER
2155+
#define MY_MQTT_CLIENT_ID
2156+
#define MY_MQTT_PUBLISH_TOPIC_PREFIX
2157+
#define MY_MQTT_SUBSCRIBE_TOPIC_PREFIX
20922158
#define MY_SIGNAL_REPORT_ENABLED
20932159
// general
20942160
#define MY_WITH_LEDS_BLINKING_INVERSE
@@ -2108,9 +2174,14 @@
21082174
#define MY_GATEWAY_ESP32
21092175
#define MY_GATEWAY_LINUX
21102176
#define MY_GATEWAY_TINYGSM
2177+
#define MY_GATEWAY_MQTT_CLIENT
2178+
#define MY_GATEWAY_SERIAL
21112179
#define MY_IP_ADDRESS
2180+
#define MY_IP_GATEWAY_ADDRESS
2181+
#define MY_IP_SUBNET_ADDRESS
21122182
#define MY_USE_UDP
21132183
#define MY_CONTROLLER_IP_ADDRESS
2184+
#define MY_CONTROLLER_URL_ADDRESS
21142185
// TinyGSM
21152186
/**
21162187
* @def MY_GSM_APN

0 commit comments

Comments
 (0)