Merge remote-tracking branch 'upstream/main' into more-usermod-fixes

usermods/BME68X_v2/README.md

@@ -1,53 +1,58 @@
 # Usermod BME68X
+
 This usermod was developed for a BME680/BME68X sensor. The BME68X is not compatible with the BME280/BMP280 chip. It has its own library. The original 'BSEC Software Library' from Bosch was used to develop the code. The measured values are displayed on the WLED info page.
 
 <p align="center"><img src="pics/pic1.png" style="width:60%;"></p>
 
 In addition, the values are published on MQTT if this is active. The topic used for this is: 'wled/[MQTT Client ID]'. The Client ID is set in the WLED MQTT settings.
+
 <p align="center"><img src="pics/pic2.png"></p>
 
 If you use HomeAssistance discovery, the device tree for HomeAssistance is created.  This is published under the topic 'homeassistant/sensor/[MQTT Client ID]' via MQTT.
+
 <p align="center"><img src="pics/pic3.png"></p>
 
 A device with the following sensors appears in HomeAssistant. Please note that MQTT must be activated in HomeAssistant.
+
 <p align="center"><img src="pics/pic4.png" style="width:60%;"></p>
 
-
 ## Features
+
 Raw sensor types
 
-	Sensor		Accuracy	Scale		Range
- 	--------------------------------------------------------------------------------------------------
-	Temperature	+/- 1.0		°C/°F		-40 to 85 °C
-	Humidity	+/- 3 		%		0 to 100 %
-	Pressure	+/- 1 		hPa		300 to 1100 hPa
-	Gas Resistance			Ohm
+Sensor		Accuracy	Scale		Range
+-----------------------------
 
+Temperature	+/- 1.0		°C/°F		-40 to 85 °C
+Humidity	+/- 3 		%		0 to 100 %
+Pressure	+/- 1 		hPa		300 to 1100 hPa
+Gas Resistance			Ohm
 The BSEC Library calculates the following values via the gas resistance
 
-	Sensor		Accuracy	Scale		Range
- 	--------------------------------------------------------------------------------------------------
-	IAQ 						value between 0 and 500
-	Static IAQ 					same as IAQ but for permanently installed devices
-	CO2 				PPM
-	VOC 				PPM
-	Gas-Percentage 			%
-
+Sensor		Accuracy	Scale		Range
+-----------------------------
 
+IAQ 						value between 0 and 500
+Static IAQ 					same as IAQ but for permanently installed devices
+CO2 				PPM
+VOC 				PPM
+Gas-Percentage 			%
 In addition the usermod calculates
 
-	Sensor		Accuracy	Scale		Range
- 	--------------------------------------------------------------------------------------------------
-	Absolute humidity	 	g/m³
-	Dew point 			°C/°F
+Sensor		Accuracy	Scale		Range
+-----------------------------
+
+Absolute humidity	 	g/m³
+Dew point 			°C/°F
 
 ### IAQ (Indoor Air Quality)
+
 The IAQ is divided into the following value groups.
+
 <p align="center"><img src="pics/pic5.png"></p>
 
 For more detailed information, please consult the enclosed Bosch product description (BME680.pdf).
 
-
 ## Calibration of the device
 
 The gas sensor of the BME68X must be calibrated. This differs from the BME280, which does not require any calibration.
@@ -67,10 +72,10 @@ The IAQ index is therefore only meaningful if IAQ Accuracy = 3. In addition to t
 
 Reasonably reliable values are therefore only achieved when accuracy displays the value 3.
 
-
-
 ## Settings
+
 The settings of the usermods are set in the usermod section of wled.
+
 <p align="center"><img src="pics/pic6.png"></p>
 
 The possible settings are
@@ -88,6 +93,7 @@ The possible settings are
 - **Del Calibration Hist:**	If a check mark is set here, the calibration file saved in the file system is deleted when the settings are saved.
 
 ### Sensors
+
 Applies to all sensors. The number of decimal places is set here. If the sensor is set to -1, it will no longer be published. In addition, the IAQ values can be activated here in verbal form.
 
 It is recommended to use the Static IAQ for the IAQ values. This is recommended by Bosch for statically placed devices.
@@ -99,6 +105,7 @@ Data is published over MQTT - make sure you've enabled the MQTT sync interface.
 In addition to outputting via MQTT, you can read the values from the Info Screen on the dashboard page of the device's web interface.
 
 Methods also exist to read the read/calculated values from other WLED modules through code.
+
 - getTemperature();	The scale °C/°F is depended to the settings
 - getHumidity();
 - getPressure();
@@ -118,15 +125,36 @@ Methods also exist to read the read/calculated values from other WLED modules th
 - getStabStatus();
 - getRunInStatus();
 
+## Compilation
+
+To enable, compile with `BME68X` in `custom_usermods` (e.g. in `platformio_override.ini`)
+
+Example:
+
+```[env:esp32_mySpecial]
+extends = env:esp32dev
+custom_usermods = ${env:esp32dev.custom_usermods} BME68X
+```
+
 ## Revision History
+
 ### Version 1.0.0
+
 - First version of the BME68X_v user module
+
 ### Version 1.0.1
+
 - Rebased to WELD Version 0.15
 - Reworked some default settings
 - A problem with the default settings has been fixed
 
+### Version 1.0.2
+
+* Rebased to WELD Version 0.16
+* Fixed: Solved compilation problems related to some macro naming interferences.
+
 ## Known problems
+
 - MQTT goes online at device start. Shortly afterwards it goes offline and takes quite a while until it goes online again. The problem does not come from this user module, but from the WLED core.
 - If you save the settings often, WLED can get stuck.
 - If many LEDS are connected to WLED, reading the sensor can cause a small but noticeable hang. The "Pause While WLED Active" option was introduced as a workaround.

usermods/BME68X_v2/library.json

@@ -1,6 +1,5 @@
 {
-  "name": "BME68X_v2",
-  "build": { "libArchive": false},
+  "name": "BME68X",
   "dependencies": {
     "boschsensortec/BSEC Software Library":"^1.8.1492"
   }