Skip to content

Commit 9809eb6

Browse files
mfalkviddhenrikekblad
authored andcommitted
Add missing keywords 2 (#1087)
* Add missing keywords and blacklist These keywords already exist in Doxygen and should be highlighted in the Arduino IDE. Some keywords should not be highlighed and are therefore added to the blacklists at end of keywords.txt * Sort keywords in each section * Add blacklist of MY_MQTT_TOPIC_PREFIX
1 parent 2994d83 commit 9809eb6

File tree

1 file changed

+162
-91
lines changed

1 file changed

+162
-91
lines changed

keywords.txt

Lines changed: 162 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -30,83 +30,99 @@ smartSleep KEYWORD2
3030
# Constants (LITERAL1)
3131
#######################################
3232
# General
33-
MY_CORE_ONLY LITERAL1
34-
MY_DISABLE_REMOTE_RESET LITERAL1
35-
MY_SMART_SLEEP_WAIT_DURATION LITERAL1
3633
MY_BAUD_RATE LITERAL1
34+
MY_CORE_ONLY LITERAL1
35+
MY_CORE_MIN_VERSION LITERAL1
36+
MY_CORE_VERSION LITERAL1
3737
MY_CRITICAL_SECTION LITERAL1
38+
MY_DISABLE_RAM_ROUTING_TABLE_FEATURE LITERAL1
39+
MY_DISABLE_REMOTE_RESET LITERAL1
40+
MY_DISABLED_SERIAL LITERAL1
41+
MY_INDICATION_HANDLER LITERAL1
3842
MY_RX_MESSAGE_BUFFER_SIZE LITERAL1
3943
MY_RX_MESSAGE_BUFFER_FEATURE LITERAL1
40-
MY_DISABLED_SERIAL LITERAL1
44+
MY_SERIAL_OUTPUT_SIZE LITERAL1
45+
MY_SLEEP_NOT_POSSIBLE LITERAL1
46+
MY_SMART_SLEEP_WAIT_DURATION LITERAL1
4147
MY_SPLASH_SCREEN_DISABLED LITERAL1
42-
MY_INDICATION_HANDLER LITERAL1
43-
MY_DISABLE_RAM_ROUTING_TABLE_FEATURE LITERAL1
48+
MY_WAKE_UP_BY_TIMER LITERAL1
4449

4550
# transport
4651
AUTO LITERAL1
47-
MY_NODE_ID LITERAL1
52+
MY_CORE_COMPATIBILITY_CHECK LITERAL1
4853
MY_DEBUG_VERBOSE_TRANSPORT LITERAL1
54+
MY_NODE_ID LITERAL1
4955
MY_PARENT_NODE_ID LITERAL1
5056
MY_PARENT_NODE_IS_STATIC LITERAL1
51-
MY_REGISTRATION_FEATURE LITERAL1
52-
MY_REGISTRATION_DEFAULT LITERAL1
57+
MY_PASSIVE_NODE LITERAL1
58+
MY_RAM_ROUTING_TABLE_FEATURE LITERAL1
5359
MY_REGISTRATION_CONTROLLER LITERAL1
54-
MY_CORE_COMPATIBILITY_CHECK LITERAL1
60+
MY_REGISTRATION_DEFAULT LITERAL1
61+
MY_REGISTRATION_FEATURE LITERAL1
62+
MY_REGISTRATION_RETRIES LITERAL1
63+
MY_REPEATER_FEATURE LITERAL1
64+
MY_ROUTING_TABLE_SAVE_INTERVAL_MS LITERAL1
65+
MY_SIGNAL_REPORT_ENABLED LITERAL1
66+
MY_SLEEP_TRANSPORT_RECONNECT_TIMEOUT_MS LITERAL1
67+
MY_SMART_SLEEP_WAIT_DURATION_MS LITERAL1
68+
MY_TRANSPORT_CHKUPL_INTERVAL_MS LITERAL1
69+
MY_TRANSPORT_DISCOVERY_INTERVAL_MS LITERAL1
70+
MY_TRANSPORT_MAX_TSM_FAILURES LITERAL1
71+
MY_TRANSPORT_MAX_TX_FAILURES LITERAL1
5572
MY_TRANSPORT_SANITY_CHECK LITERAL1
5673
MY_TRANSPORT_SANITY_CHECK_INTERVAL LITERAL1
57-
MY_TRANSPORT_WAIT_READY_MS LITERAL1
74+
MY_TRANSPORT_SANITY_CHECK_INTERVAL_MS LITERAL1
75+
MY_TRANSPORT_STATE_RETRIES LITERAL1
76+
MY_TRANSPORT_STATE_TIMEOUT_MS LITERAL1
77+
MY_TRANSPORT_TIMEOUT_EXT_FAILURE_STATE_MS LITERAL1
78+
MY_TRANSPORT_TIMEOUT_FAILURE_STATE_MS LITERAL1
5879
MY_TRANSPORT_UPLINK_CHECK_DISABLED LITERAL1
59-
MY_REPEATER_FEATURE LITERAL1
60-
MY_PASSIVE_NODE LITERAL1
61-
MY_SIGNAL_REPORT_ENABLED LITERAL1
80+
MY_TRANSPORT_WAIT_READY_MS LITERAL1
6281

6382
# debug
6483
MY_DEBUG LITERAL1
6584
MY_DEBUGDEVICE LITERAL1
66-
MY_DEBUG_OTA LITERAL1
67-
MY_DEBUG_OTA_DISABLE_ACK LITERAL1
68-
MY_SPECIAL_DEBUG LITERAL1
6985
MY_DEBUG_VERBOSE_GATEWAY LITERAL1
86+
MY_SPECIAL_DEBUG LITERAL1
7087

7188
# OTA
72-
MY_OTA_FIRMWARE_FEATURE LITERAL1
73-
MY_OTA_FLASH_SS LITERAL1
74-
MY_OTA_FLASH_JDECID LITERAL1
75-
MY_SPIFLASH_SST25TYPE LITERAL1
89+
MY_DEBUG_OTA LITERAL1
90+
MY_DEBUG_OTA_DISABLE_ACK LITERAL1
7691
MY_DEBUG_VERBOSE_OTA_UPDATE LITERAL1
77-
MY_WITH_LEDS_BLINKING_INVERSE LITERAL1
92+
MY_DEFAULT_ERR_LED_PIN LITERAL1
7893
MY_DEFAULT_LED_BLINK_PERIOD LITERAL1
79-
MY_WITH_LEDS_BLINKING_INVERSE LITERAL1
8094
MY_DEFAULT_RX_LED_PIN LITERAL1
8195
MY_DEFAULT_TX_LED_PIN LITERAL1
82-
MY_DEFAULT_ERR_LED_PIN LITERAL1
8396
MY_INCLUSION_MODE_FEATURE LITERAL1
8497
MY_INCLUSION_BUTTON_FEATURE LITERAL1
8598
MY_INCLUSION_MODE_BUTTON_PIN LITERAL1
8699
MY_INCLUSION_MODE_DURATION LITERAL1
87100
MY_INCLUSION_LED_PIN LITERAL1
101+
MY_OTA_FIRMWARE_FEATURE LITERAL1
102+
MY_OTA_FLASH_SS LITERAL1
103+
MY_OTA_FLASH_JDECID LITERAL1
88104
MY_OTA_LOG_RECEIVER_FEATURE LITERAL1
89105
MY_OTA_LOG_SENDER_FEATURE LITERAL1
90-
MY_DEBUG_OTA LITERAL1
91-
MY_DEBUG_OTA_DISABLE_ACK LITERAL1
92106
MY_OTA_USE_I2C_EEPROM LITERAL1
107+
MY_SPIFLASH_SST25TYPE LITERAL1
108+
MY_WITH_LEDS_BLINKING_INVERSE LITERAL1
93109

94110
# Signing
95111
MY_DEBUG_VERBOSE_SIGNING LITERAL1
96-
MY_SECURITY_SIMPLE_PASSWD LITERAL1
97-
MY_SIGNING_SIMPLE_PASSWD LITERAL1
98112
MY_ENCRYPTION_SIMPLE_PASSWD LITERAL1
113+
MY_NODE_LOCK_FEATURE LITERAL1
114+
MY_NODE_UNLOCK_PIN LITERAL1
115+
MY_NODE_LOCK_COUNTER_MAX LITERAL1
116+
MY_SECURITY_SIMPLE_PASSWD LITERAL1
99117
MY_SIGNING_ATSHA204 LITERAL1
100-
MY_SIGNING_SOFT LITERAL1
101-
MY_VERIFICATION_TIMEOUT_MS LITERAL1
102-
MY_SIGNING_NODE_WHITELISTING LITERAL1
103118
MY_SIGNING_ATSHA204_PIN LITERAL1
119+
MY_SIGNING_NODE_WHITELISTING LITERAL1
120+
MY_SIGNING_SIMPLE_PASSWD LITERAL1
121+
MY_SIGNING_SOFT LITERAL1
104122
MY_SIGNING_SOFT_RANDOMSEED_PIN LITERAL1
105123
MY_SIGNING_REQUEST_SIGNATURES LITERAL1
106124
MY_SIGNING_WEAK_SECURITY LITERAL1
107-
MY_NODE_LOCK_FEATURE LITERAL1
108-
MY_NODE_UNLOCK_PIN LITERAL1
109-
MY_NODE_LOCK_COUNTER_MAX LITERAL1
125+
MY_VERIFICATION_TIMEOUT_MS LITERAL1
110126

111127
# Random
112128
MY_HW_HAS_GETENTROPY LITERAL1
@@ -125,26 +141,25 @@ MY_GSM_USR LITERAL1
125141

126142
# SoftSPI
127143
MY_SOFTSPI LITERAL1
128-
MY_SOFT_SPI_SCK_PIN LITERAL1
129144
MY_SOFT_SPI_MISO_PIN LITERAL1
130145
MY_SOFT_SPI_MOSI_PIN LITERAL1
146+
MY_SOFT_SPI_SCK_PIN LITERAL1
131147

132148
# RF24
133-
MY_RADIO_RF24 LITERAL1
134149
MY_DEBUG_VERBOSE_RF24 LITERAL1
150+
MY_RADIO_RF24 LITERAL1
151+
MY_RF24_BASE_RADIO_ID LITERAL1
135152
MY_RF24_ENABLE_ENCRYPTION LITERAL1
136-
MY_RF24_SPI_SPEED LITERAL1
137153
MY_RF24_CE_PIN LITERAL1
154+
MY_RF24_CHANNEL LITERAL1
138155
MY_RF24_CS_PIN LITERAL1
156+
MY_RF24_DATARATE LITERAL1
139157
MY_RF24_IRQ_PIN LITERAL1
140158
MY_RF24_PA_LEVEL LITERAL1
141-
MY_RF24_CHANNEL LITERAL1
142-
MY_RF24_DATARATE LITERAL1
143-
MY_RF24_BASE_RADIO_ID LITERAL1
144159
MY_RF24_POWER_PIN LITERAL1
160+
MY_RF24_SPI_SPEED LITERAL1
145161

146162
# NRF5
147-
MY_RADIO_NRF5_ESB LITERAL1
148163
MY_DEBUG_VERBOSE_NRF5_ESB LITERAL1
149164
MY_NRF5_ESB_ADDR_WIDTH LITERAL1
150165
MY_NRF5_ESB_BASE_RADIO_ID LITERAL1
@@ -155,103 +170,159 @@ MY_NRF5_ESB_PA_LEVEL LITERAL1
155170
MY_NRF5_ESB_RX_BUFFER_SIZE LITERAL1
156171
MY_NRF5_ESB_REVERSE_ACK_RX LITERAL1
157172
MY_NRF5_ESB_REVERSE_ACK_TX LITERAL1
173+
MY_RADIO_NRF5_ESB LITERAL1
158174

159175
# RFM95
160-
MY_RADIO_RFM95 LITERAL1
161176
MY_DEBUG_VERBOSE_RFM95 LITERAL1
162-
MY_RFM95_MODEM_CONFIGRUATION LITERAL1
163-
MY_RFM95_FREQUENCY LITERAL1
164-
MY_RFM95_TX_POWER LITERAL1
165-
MY_RFM95_CS_PIN LITERAL1
166-
MY_RFM95_RST_PIN LITERAL1
167-
MY_RFM95_SPI_SPEED LITERAL1
168-
MY_RFM95_IRQ_PIN LITERAL1
169-
MY_RFM95_IRQ_NUM LITERAL1
170-
MY_RFM95_ATC_TARGET_RSSI LITERAL1
177+
MY_RADIO_RFM95 LITERAL1
171178
MY_RFM95_ATC_MODE_DISABLED LITERAL1
179+
MY_RFM95_ATC_TARGET_RSSI LITERAL1
172180
MY_RFM95_ATC_TARGET_RSSI_DBM LITERAL1
181+
MY_RFM95_CS_PIN LITERAL1
182+
MY_RFM95_FREQUENCY LITERAL1
183+
MY_RFM95_IRQ_NUM LITERAL1
184+
MY_RFM95_IRQ_PIN LITERAL1
173185
MY_RFM95_MAX_POWER_LEVEL_DBM LITERAL1
186+
MY_RFM95_MODEM_CONFIGRUATION LITERAL1
174187
MY_RFM95_POWER_PIN LITERAL1
188+
MY_RFM95_RST_PIN LITERAL1
189+
MY_RFM95_SPI_SPEED LITERAL1
175190
MY_RFM95_TCXO LITERAL1
191+
MY_RFM95_TX_POWER LITERAL1
176192

177193
# RFM69
178-
MY_RADIO_RFM69 LITERAL1
179194
MY_DEBUG_VERBOSE_RFM69 LITERAL1
180195
MY_DEBUG_VERBOSE_RFM69_REGISTERS LITERAL1
181-
MY_RFM69_FREQUENCY LITERAL1
182-
MY_IS_RFM69HW LITERAL1
183-
MY_RFM69_NEW_DRIVER LITERAL1
184-
MY_RFM69_TX_POWER_DBM LITERAL1
185-
MY_RFM69_ATC_TARGET_RSSI_DBM LITERAL1
196+
MY_IS_RFM69HW LITERAL1 LITERAL1
197+
MY_RADIO_RFM69 LITERAL1 LITERAL1
186198
MY_RFM69_ATC_MODE_DISABLED LITERAL1
187-
MY_RFM69_MAX_POWER_LEVEL_DBM LITERAL1
188-
MY_RFM69_NETWORKID LITERAL1
189-
MY_RFM69_RST_PIN LITERAL1
190-
MY_RFM69_IRQ_PIN LITERAL1
191-
MY_RFM69_IRQ_NUM LITERAL1
192-
MY_RFM69_CS_PIN LITERAL1
193-
MY_RFM69_ENABLE_ENCRYPTION LITERAL1
194-
MY_RFM69_ENABLE_LISTENMODE LITERAL1
195-
MY_RFM69_DEFAULT_LISTEN_RX_US LITERAL1
196-
MY_RFM69_DEFAULT_LISTEN_IDLE_US LITERAL1
197-
MY_RFM69_SPI_SPEED LITERAL1
198-
MY_RFM69_BITRATE_MSB LITERAL1
199+
MY_RFM69_ATC_TARGET_RSSI_DBM LITERAL1
199200
MY_RFM69_BITRATE_LSB LITERAL1
201+
MY_RFM69_BITRATE_MSB LITERAL1
202+
MY_RFM69_CS_PIN LITERAL1
200203
MY_RFM69_CSMA_ADD_DELAY_BASE LITERAL1
201204
MY_RFM69_CSMA_ADD_DELAY_COUNT LITERAL1
202-
MY_RFM69_POWER_PIN LITERAL1
205+
MY_RFM69_DEFAULT_LISTEN_IDLE_US LITERAL1
206+
MY_RFM69_DEFAULT_LISTEN_RX_US LITERAL1
207+
MY_RFM69_ENABLE_ENCRYPTION LITERAL1
208+
MY_RFM69_ENABLE_LISTENMODE LITERAL1
209+
MY_RFM69_FREQUENCY LITERAL1
210+
MY_RFM69_IRQ_NUM LITERAL1
211+
MY_RFM69_IRQ_PIN LITERAL1
212+
MY_RFM69_MAX_POWER_LEVEL_DBM LITERAL1
203213
MY_RFM69_MODEM_CONFIGURATION LITERAL1
214+
MY_RFM69_NETWORKID LITERAL1
215+
MY_RFM69_NEW_DRIVER LITERAL1
216+
MY_RFM69_POWER_PIN LITERAL1
217+
MY_RFM69_RST_PIN LITERAL1
218+
MY_RFM69_SPI_SPEED LITERAL1
219+
MY_RFM69_TX_POWER_DBM LITERAL1
204220

205221
# RS485
206222
MY_RS485 LITERAL1
207223
MY_RS485_BAUD_RATE LITERAL1
208-
MY_RS485_MAX_MESSAGE_LENGTH LITERAL1
209-
MY_RS485_HWSERIAL LITERAL1
210224
MY_RS485_DE_PIN LITERAL1
225+
MY_RS485_HWSERIAL LITERAL1
226+
MY_RS485_MAX_MESSAGE_LENGTH LITERAL1
211227
MY_RS485_SOH_COUNT LITERAL1
212228

213229
# Gateway / MQTT
214-
MY_GATEWAY_SERIAL LITERAL1
215-
MY_GATEWAY_W5100 LITERAL1
216-
MY_W5100_SPI_EN LITERAL1
230+
MY_GATEWAY_CLIENT_MODE LITERAL1
217231
MY_GATEWAY_ENC28J60 LITERAL1
218232
MY_GATEWAY_ESP8266 LITERAL1
233+
MY_GATEWAY_MQTT_CLIENT LITERAL1
234+
MY_GATEWAY_SERIAL LITERAL1
235+
MY_GATEWAY_W5100 LITERAL1
219236
MY_INCLUSION_BUTTON_EXTERNAL_PULLUP LITERAL1
220-
MY_MQTT_SUBSCRIBE_TOPIC_PREFIX LITERAL1
221-
MY_MQTT_PUBLISH_TOPIC_PREFIX LITERAL1
222237
MY_MQTT_CLIENT_ID LITERAL1
223-
MY_GATEWAY_MQTT_CLIENT LITERAL1
224238
MY_MQTT_CLIENT_PUBLISH_RETAIN LITERAL1
239+
MY_MQTT_PUBLISH_TOPIC_PREFIX LITERAL1
240+
MY_MQTT_SUBSCRIBE_TOPIC_PREFIX LITERAL1
241+
MY_W5100_SPI_EN LITERAL1
225242

226243
# Ethernet
227-
MY_PORT LITERAL1
228-
MY_IP_ADDRESS LITERAL1
229-
MY_USE_UDP LITERAL1
230-
MY_IP_RENEWAL_INTERVAL LITERAL1
231-
MY_MAC_ADDRESS LITERAL1
232244
MY_CONTROLLER_IP_ADDRESS LITERAL1
233245
MY_CONTROLLER_URL_ADDRESS LITERAL1
234246
MY_GATEWAY_MAX_CLIENTS LITERAL1
235-
MY_GATEWAY_MAX_SEND_LENGTH LITERAL1
236247
MY_GATEWAY_MAX_RECEIVE_LENGTH LITERAL1
248+
MY_GATEWAY_MAX_SEND_LENGTH LITERAL1
249+
MY_IP_ADDRESS LITERAL1
237250
MY_IP_GATEWAY_ADDRESS LITERAL1
251+
MY_IP_RENEWAL_INTERVAL LITERAL1
252+
MY_IP_RENEWAL_INTERVAL_MS LITERAL1
238253
MY_IP_SUBNET_ADDRESS LITERAL1
254+
MY_MAC_ADDRESS LITERAL1
255+
MY_PORT LITERAL1
256+
MY_USE_UDP LITERAL1
239257

240258
# ESP8266
241-
MY_ESP8266_SSID LITERAL1
242-
MY_ESP8266_PASSWORD LITERAL1
243259
MY_ESP8266_BSSID LITERAL1
244260
MY_ESP8266_HOSTNAME LITERAL1
261+
MY_ESP8266_PASSWORD LITERAL1
245262
MY_ESP8266_SERIAL_MODE LITERAL1
263+
MY_ESP8266_SSID LITERAL1
246264

247265
# Blacklist - autodefines that are used internally and should not be highlighted, hence commented.
248-
# MY_SIGNING_FEATURE
266+
# MY_CAP_ARCH
267+
# MY_CAP_ENCR
268+
# MY_CAP_OTA_FW
269+
# MY_CAP_RADIO
270+
# MY_CAP_RESET
271+
# MY_CAP_RXBUF
272+
# MY_CAP_SIGN
273+
# MY_CAP_TYPE
274+
# MY_CAPABILITIES
275+
# MY_DEBUG_VERBOSE_CORE
276+
# MY_GATEWAY_FEATURE
277+
# MY_RAM_ROUTING_TABLE_ENABLED
278+
# MY_SENSOR_NETWORK
279+
280+
# Blacklist - defined in ArduinoHwSAMD and therefore not responsibility of the MySensors library
281+
# MY_BAT_DETECT
282+
283+
# Blacklist - used by the Security Personalizer, not meant to be used in any other sketch
284+
# MY_AES_KEY
249285
# MY_ENCRYPTION_FEATURE
286+
# MY_HMAC_KEY
250287
# MY_LOCK_DEVICE
251-
# MY_LINUX_SERIAL_PORT
252-
# MY_LINUX_SERIAL_IS_PTY
288+
# MY_LOCK_MCU
289+
# MY_SIGNING_FEATURE
290+
# MY_SOFT_SERIAL
291+
292+
# Blacklist - internal, not meant to be used by users
293+
# MY_EXT_EEPROM_PAGE_SIZE
294+
# MY_EXT_EEPROM_SIZE
295+
# MY_EXT_EEPROM_TWI_CLOCK
296+
# MY_HW_ERR_LED_PIN
297+
# MY_HW_RTC
298+
# MY_HW_RTC_IRQ_HANDLER
299+
# MY_HW_RTC_IRQN
300+
# MY_HW_TX_LED_PIN
301+
# MY_HWID_PADDING_BYTE
302+
# MY_INCLUSION_BUTTON_PRESSED
303+
# MY_IS_GATEWAY
304+
# MY_NODE_TYPE
305+
# MY_OTA_BOOTLOADER_MAJOR_VERSION
306+
# MY_OTA_BOOTLOADER_MINOR_VERSION
307+
# MY_OTA_BOOTLOADER_VERSION
308+
# MY_OTA_RETRY
309+
# MY_OTA_RETRY_DELAY
310+
# MY_SDCARD_CS
311+
312+
# Blacklist - used by the Raspberry Pi gateway and not meant to be used by users
313+
# MY_GATEWAY_LINUX
314+
# MY_LINUX_CONFIG_FILE
315+
# MY_LINUX_IS_SERIAL_PTY
253316
# MY_LINUX_SERIAL_GROUPNAME
317+
# MY_LINUX_SERIAL_IS_PTY
318+
# MY_LINUX_SERIAL_PORT
254319
# MY_LINUX_SERIAL_PTY
255-
# MY_LINUX_IS_SERIAL_PTY
256-
# MY_GATEWAY_LINUX
320+
321+
# Blacklist - deprecated and should therefore not be highlighted anymore
322+
# MY_LEDS_BLINKING_FEATURE
323+
# MY_TRANSPORT_DONT_CARE_MODE
324+
325+
# Blacklist - descriptional only
326+
# MY_XYZ_POWER_PIN
327+
# MY_MQTT_TOPIC_PREFIX
257328

0 commit comments

Comments
 (0)