Skip to content

Commit

Permalink
Merge pull request #1290 from barbudor/improve_bleesp32_build_instruc…
Browse files Browse the repository at this point in the history
…tions

Improve bleesp32 build instructions
  • Loading branch information
barbudor authored Oct 5, 2023
2 parents 18b3622 + 05ec205 commit 72d22e2
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 17 deletions.
16 changes: 15 additions & 1 deletion docs/Bluetooth_ESP32.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,24 @@ This allows for the receiving of BLE advertisements from BLE devices, including

??? failure "This feature is included only in tasmota32-bluetooth.bin"

When [compiling your build](Compile-your-build) add the following to `user_config_override.h`:
When [compiling your build](Compile-your-build), you need to

(1) Add the following to `user_config_override.h`:
```c++
#define USE_BLE_ESP32 // Add support for ESP32 as a BLE-bridge (+9k2? mem, +292k? flash)
```
(2) Copy `platformio_override_sample.ini` to `platformio_override.ini`

(3) In `platformio_override.ini`, search for the following lines and remove the `;` in front of the 2nd line if it is there
```
; *** uncomment the following line if you use Bluetooth or Apple Homekit in a Tasmota32 build. Reduces compile time
; lib/libesp32_div
```
becomes
```
; *** uncomment the following line if you use Bluetooth or Apple Homekit in a Tasmota32 build. Reduces compile time
lib/libesp32_div
```

Be aware, enabling of the native BLE on ESP32 has an impact on Wi-Fi performance. Although later SDK helped a bit, expect more lag on the web interface and on MQTT.
If only controlling BLE devices, then scanning can be disabled, which will minimize Wi-Fi impact.
Expand Down
2 changes: 1 addition & 1 deletion docs/Gitpod.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Step 1-3 only applies to ESP8266, where you should use the `.bin.gz` file for up

#### Serial Flash

Follow the same [procedure for flashing](../Getting-Started#flashing) as you would any new device.
Follow the same [procedure for flashing](Getting-Started#flashing) as you would any new device.

##### Webserial ESPTool

Expand Down
33 changes: 20 additions & 13 deletions docs/Rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,12 +267,16 @@ Rule1 "
## Conditional Rules
!!! failure "This feature is not included in precompiled binaries."
To use it you must [compile your build](Compile-your-build). Add the following to `user_config_override.h`:
```arduino
#define USE_EXPRESSION // Add support for expression evaluation in rules (+3k2 code, +64 bytes mem)
#define SUPPORT_IF_STATEMENT // Add support for IF statement in rules (+4k2 code, -332 bytes mem)
```
!!! failure
This features is not included in standard ESP8266 binaries such as `tasmota`, `tasmota-sensors`, `tasmota-lite`.
To use it, you must [compile your build](Compile-your-build) and add the following to `user_config_override.h`:
```arduino
#define SUPPORT_IF_STATEMENT // Add support for IF statement in rules (+4k2 code, -332 bytes mem)
```
!!! note
This feature is included in ESP32 builds as well as in ESP8266 builds for boards with more than 1MB Flash. This include `tasmota-4M`, `tasmota-zbbridge`, `tasmota-zigbee`.
----
#### Major features
Expand Down Expand Up @@ -369,13 +373,16 @@ Rule1
## Expressions in Rules
!!! failure "This feature is not included in precompiled binaries."
!!! failure
This features is not included in standard ESP8266 binaries such as `tasmota`, `tasmota-sensors`, `tasmota-lite`.
To use it, you must [compile your build](Compile-your-build) and add the following to `user_config_override.h`:
To use it you must [compile your build](Compile-your-build). Add the following to `user_config_override.h`:
```arduino
#define USE_EXPRESSION // Add support for expression evaluation in rules (+3k2 code, +64 bytes mem)
#define SUPPORT_IF_STATEMENT // Add support for IF statement in rules (+4k2 code, -332 bytes mem)
```
```arduino
#define USE_EXPRESSION // Add support for expression evaluation in rules (+3k2 code, +64 bytes mem)
```
!!! note
This feature is included in ESP32 builds as well as in ESP8266 builds for boards with more than 1MB Flash. This include `tasmota-4M`, `tasmota-zbbridge`, `tasmota-zigbee`.
----
Beginning with Tasmota version 6.4.1.14, an optional feature for using mathematical expressions in rules was introduced.
Expand All @@ -399,7 +406,7 @@ Expressions can use of the following operators. They are listed by the order of
!!! example
* `1+2*2` results in 5.0 as the multiplication is done first due to its higher priority
* `(1+2)*2` results in 6.0
* `(1+2)*2` results in 6.0
In addition to numeric constants, the following symbolic values can be used:
Expand Down
2 changes: 1 addition & 1 deletion docs/Tuya-Convert.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

Tuya-Convert comes with [`tasmota-lite.bin`](http://ota.tasmota.com/tasmota/tasmota-lite.bin) build which includes basic Tasmota features required for normal operation with Tuya devices, while removing sensors, IR, RF and home automation integration support for reduced filesize. It is recommended to upgrade to a full build of the firmware (`tasmota.bin`) if needed.

**To ensure Tasmota runs reliably execute the command [`reset 5`](Commands#reset) after Tuya-Convert is finished and Tasmota is up and running.** Doing this removes fragments of the original firmware left in flash which can create issues in the future. After all that is done you can proceed with the needed [configuration](../Getting-Started#initial-configuration) of your device.
**To ensure Tasmota runs reliably execute the command [`reset 5`](Commands#reset) after Tuya-Convert is finished and Tasmota is up and running.** Doing this removes fragments of the original firmware left in flash which can create issues in the future. After all that is done you can proceed with the needed [configuration](Getting-Started#initial-configuration) of your device.

Help and troubleshooting for Tuya-Convert is done on [Tuya-Convert's Github](https://github.com/ct-Open-Source/tuya-convert/issues).

Expand Down
2 changes: 1 addition & 1 deletion docs/TuyaMCU-Devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ If an MCU is present, bridge RST to GND on the MCU

Use a 6.6.0.10 Tasmota version or higher. There are lots of Tuya Serial fixes / features added in there and the tutorial below expects them.

Now you need to follow the commands explained in the [flashing tutorial](../Getting-Started#flashing).
Now you need to follow the commands explained in the [flashing tutorial](Getting-Started#flashing).

TIP: If you are using jumper headers use `sleep 15 &&` before your commands, this would free your hand and give you some time to set the jumper pins and connect the USB to PC.

Expand Down

0 comments on commit 72d22e2

Please sign in to comment.