Skip to content

Commit

Permalink
Merge pull request #1423 from SteWers/fix-links-2
Browse files Browse the repository at this point in the history
Fix more links and formatting
  • Loading branch information
arendst authored Oct 27, 2024
2 parents eeb2f51 + 0c42cb2 commit 005f9f6
Show file tree
Hide file tree
Showing 9 changed files with 43 additions and 49 deletions.
74 changes: 34 additions & 40 deletions docs/AS3935.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ In the **_Configuration -> Configure Module_** page assign:
2. GPIOy to `I2C SCL`
3. GPIOz to `AS3935`

!!! tip "Note for I^2^C Use"
You will need to wire up all of the associated pins for the different boards.<br>
- Always connect CS and MISO to GND.<br>
- If "SI" is present, you need to connect to VCC.<br>
See some wiring on the Board pictures below. [I^2^C wiring](#breakout-boards-and-wiring-for-I~2~C-use)
!!! tip "Note for using I^2^C"
- You will need to wire up all of the associated pins for the different boards
- Always connect `CS` and `MISO` to `GND`
- If `SI` is present, you need to connect to `VCC`
- See some wiring on the [board pictures](#breakout-boards-and-wiring-for-i2c-use) below

![Module Settings](https://user-images.githubusercontent.com/48546979/79037994-1bedab80-7bd6-11ea-88db-0d88dcb05628.png)

Expand Down Expand Up @@ -79,23 +79,20 @@ and in MQTT topic when an Event occurs:
AS3935autonf | Set Auto Tune for Noise Level | 0/1 (On/Off) | (1 Bit)
AS3935autodisturber | Set Auto-Disturber | 0/1 (On/Off) | (1 Bit)
AS3935autonfmax | Auto Tune with INDOOR and OUTDOOR | 0/1 (On/Off) | (1 Bit)
AS3935lightevent | mqtt messages only for lightning events | 0/1 (On/Off) | (1 Bit)
AS3935noirqevent | suppress mqtt "IRQ with no Event" Messages | 0/1 (On/Off) | (1 Bit)
AS3935lightevent | MQTT messages only for lightning events | 0/1 (On/Off) | (1 Bit)
AS3935noirqevent | suppress MQTT "IRQ with no Event" Messages | 0/1 (On/Off) | (1 Bit)
AS3935settings | show all settings | no argument |
AS3935calibrate | auto calibrate the internal Capacitors | no argument |
AS3935disttime | time for reset Disturber in auto-mode | 0-15 min. | (4 Bit)
AS3935nftime | time for auto-Nf threshold | 0-15 min | (4 Bit)


!!! note "Note for `AS3935Calibrate`"
Normally you don't need the calibrate function. If you buy the AS3935, the module has a sticker on it with the calibrated cap.
Use `AS3935Settunecaps` for setting up this value.<br>
if the calibration fails, it is possible that you have a board with the wrong caps on it! (some CJMCU-Boards)
Normally you don't need the calibrate function. If you buy the AS3935, the module has a sticker on it with the calibrated cap. Use `AS3935Settunecaps` for setting up this value. If the calibration fails, it is possible that you have a board with the wrong caps on it! (Some CJMCU-Boards)

## MQTT Events

## Mqtt Events:

No.| Description | Suppress with <br> Command<br>```AS3935lightevent``` | Suppress with <br>Command<br>```AS3935noirqevent```
No.| Description | Suppress with Command<br>`AS3935lightevent` | Suppress with Command<br>`AS3935noirqevent`
:-:|--------------------------------------|:-----------------------------------:|:-----------------------------------:
0 | no event | |
1 | Lightning with Distance detected | |
Expand All @@ -109,9 +106,9 @@ No.| Description | Suppress with <br> Command<br>```AS3
9 | Device is Powerd Off | |


## NF setting table:
## NF setting table

Setting table of the NF-noise sensitivity and stages:
Setting table of the NF-noise sensitivity and stages

Stages | NF-LEV | AFE-GB | uVrms | Sensitivity
-----------|--------|------------|-------|-------------------
Expand All @@ -134,35 +131,32 @@ Setting table of the NF-noise sensitivity and stages:


!!! tips "Hint and Tips"
- take a stabilized power supply.
- keep a distance of at least 200 mm from the ESP and the AS3935
- be careful with "ready to Use" devices like Sonoff, etc. they don't have a good power supply inside.
- use a Ferrit clamp filter on the sensor cable.
- wire all related Pins for I^2^C use.
- take a stabilized power supply
- keep a distance of at least 200 mm from the ESP and the AS3935
- be careful with _ready to use_ devices like Sonoff, etc. They don't have a good power supply inside
- use a ferrit clamp filter on the sensor cable
- wire all related pins for I^2^C use

You can find some troubleshooting tips in the [Tasmota GitHub discussion](https://github.com/arendst/Tasmota/pull/8130).

## Breakout Boards and Wiring for I^2^C use:

#### PlayingwithFusion Board:<br>
![AS3935](_media/peripherals/PWF_AS3935.jpg)<br>
#### Sparkfun Board V2.0:<br>
![AS3935](_media/peripherals/Sparkfun_AS3935.jpg)<br>
#### Embedded Adventures Board:<br>
![AS3935](_media/peripherals/EA_MOD1016.jpg)<br>
#### CJMCU Board:<br>
![AS3935](_media/peripherals/CJMCU_AS3935.jpg)<br>
#### GY-AS3935 Board:<br>
![AS3935](_media/peripherals/GY_AS3935.jpg)<br>
<br>
<br>

## Breakout Boards Issues:
## Breakout Boards and Wiring for I^2^C use

#### PlayingwithFusion Board
![AS3935](_media/peripherals/PWF_AS3935.jpg)
#### Sparkfun Board V2.0
![AS3935](_media/peripherals/Sparkfun_AS3935.jpg)
#### Embedded Adventures Board
![AS3935](_media/peripherals/EA_MOD1016.jpg)
#### CJMCU Board
![AS3935](_media/peripherals/CJMCU_AS3935.jpg)
#### GY-AS3935 Board
![AS3935](_media/peripherals/GY_AS3935.jpg)

## Breakout Boards Issues
!!! warning
"Some type of this sensor have wrong capacitors (100pF and 1000pF) installed and the calibration fails.
The correct caps are 680pF and 270pF." <br>
Some type of this sensor have wrong capacitors (100pF and 1000pF) installed and the calibration fails. The correct caps are 680pF and 270pF.

![AS3935](_media/peripherals/CJMCU_AS3935_Wrong.jpg)<br><br>
![AS3935](_media/peripherals/CJMCU_AS3935_Wrong.jpg)

## Datasheet:
## Datasheet
[Datasheet from Mouser Web Site](https://www.mouser.com/datasheet/2/588/ams_AS3935_Datasheet_EN_v5-1214568.pdf)
2 changes: 1 addition & 1 deletion docs/Bluetooth.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Telink Flashers allow the generation of a bind_key by faking a pairing with the

Use the bind_key and MAC address of the sensor to use with command `NRFkey`. Tasmota will receive the sensor data roughly every 10 minutes (in two chunks for humidity and temperature with about a minute in between) and decode the data. This is the most energy efficient way.

The current way of storing these keys on the NRF24L01 is to use [`NRFkey`](Commands.md#nrf32key)):
The current way of storing these keys on the NRF24L01 is to use [`NRFkey`](Commands.md#nrfkey)):

```haskell
rule1 on System#Boot do backlog NRFkey 00112233445566778899AABBCCDDEEFF112233445566; NRFkey 00112233445566778899AABBCCDDEEFF112233445566; NRFPage 6; NRFUse 0; NRFUse 4 endon
Expand Down
2 changes: 1 addition & 1 deletion docs/Buttons-and-Switches.md
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ Multipress functions for 2 and more presses cannot be changed using SetOptions o

### Changing Default Functionality

If a [`ButtonTopic`](Commands.md#buttontopic) (and if [`SetOption1 1`](Commands.md#setoption1)) or [`SwitchTopic 1`](Commands.md#switchtopic) is defined (and [`SwitchMode`](Commands.md#switchmode) is set to `5` or `6`) and a button is pressed longer than defined Key Hold Time ([`SetOption32`](Commands.md#setoption32) default 4 seconds) an MQTT message like `cmnd/%topic%/POWER HOLD` will be sent. `HOLD` can be changed with [`StateText4`](Commands.md#StateText).
If a [`ButtonTopic`](Commands.md#buttontopic) (and if [`SetOption1 1`](Commands.md#setoption1)) or [`SwitchTopic 1`](Commands.md#switchtopic) is defined (and [`SwitchMode`](Commands.md#switchmode) is set to `5` or `6`) and a button is pressed longer than defined Key Hold Time ([`SetOption32`](Commands.md#setoption32) default 4 seconds) an MQTT message like `cmnd/%topic%/POWER HOLD` will be sent. `HOLD` can be changed with [`StateText4`](Commands.md#statetext).

Command [`SetOption11`](Commands.md#setoption11) allows for swapping the functionality between the SINGLE and DOUBLE press of the push button.

Expand Down
2 changes: 1 addition & 1 deletion docs/Device-Recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Implemented for situations where a device cannot be reset to firmware defaults b
2. Power the device on and off six times with intervals lower than 10 seconds and leave it on after seventh time
3. Fast power cycle device recovery should activate and the device should be reset to firmware defaults

If you flashed a precompiled binary you can [reconfigure](Getting-Started.md#configure-wi-fi) the device using the web UI after the reset.
If you flashed a precompiled binary you can [reconfigure](Getting-Started.md#initial-configuration) the device using the web UI after the reset.

## After Recovery
Once recovered, the device should be observed that it operates without instabilities before attempting to configure the device in any way. If the device still does not, follow these steps if you are able to configure its Wi-Fi and connect:
Expand Down
2 changes: 1 addition & 1 deletion docs/ESP32.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Enable display of ESP32 internal temperature with [`SetOption146 1`](Commands.md
```json
{"Time":"2021-01-01T00:00:00","ESP32":{"Temperature":41.7},"TempUnit":"C"}
```
You can deactivate sensor by using command [`SetSensor127 0`](Commands.md#setsensor127)
You can deactivate sensor by using command [`SetSensor127 0`](Commands.md#setsensor)

### DAC

Expand Down
2 changes: 1 addition & 1 deletion docs/Esptool.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
How to setup and configure Esptool for Tasmota upload on an esp8266

The information below is for the Python version of esptool - If you want to use the Windows/Linux/OSX(MAC) executable version of esptool (as would be included in Arduino ESP8266 cores) then please go to the [esptool executable (Windows & Linux)](Esptool#esptool-executable-windows-linux) section at the bottom.
The information below is for the Python version of esptool - If you want to use the Windows/Linux/OSX(MAC) executable version of esptool (as would be included in Arduino ESP8266 cores) then please go to the [esptool executable (Windows, MacOs and Linux)](#esptool-executable-windows-macos-and-linux) section at the bottom.

## Download Esptool
If you do not have an installed copy of Python download and install it from <https://www.python.org/>.
Expand Down
4 changes: 2 additions & 2 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ If you flashed a light bulb or any device without a built-in button and entered
First thing to try when having Wi-Fi issues: `Reset 3` which will erase wi-fi calibration data only and will keep configuration intact. Make sure to power cycle restart after that. If that doesn't help try rebooting the router as well

As a last resort try :
Erase all flash using esptool.py or esptool.exe and flash via serial (as explained [here](Getting-Started.md#esptoolpy)) using [the latest precompiled binaries](http://ota.tasmota.com/tasmota/).
Erase all flash using esptool.py or esptool.exe and flash via serial (as explained [here](Getting-Started.md#__tabbed_1_3)) using [the latest precompiled binaries](http://ota.tasmota.com/tasmota/).

This approach has solved many of the reported issues. Sometimes this is due to a bad flash, a bad OTA or invalid data that remains in the flash where the SDK memory is.

Expand Down Expand Up @@ -291,7 +291,7 @@ Be sure to press the button correctly, you must "feel" a click. If your on-devic

- If esptool.py stops at "Uploading stub...", use --no-stub

- If the flash fails or the device does not operate as expected, try using the default ESP82xx boot ROM baud rate - `74880`. This is the baud rate the ESP82xx is set to by default when it boots into programming mode. It can be specified as a command line option in [esptool.py](Getting-Started.md#esptoolpy) (`-b`) and [esptool.exe](Getting-Started.md#esptool-executable) (`-cb`).
- If the flash fails or the device does not operate as expected, try using the default ESP82xx boot ROM baud rate - `74880`. This is the baud rate the ESP82xx is set to by default when it boots into programming mode. It can be specified as a command line option in [esptool.py](Getting-Started.md#__tabbed_1_3) (`-b`) and esptool.exe (`-cb`).

You may also want to select a serial monitor/terminal capable of setting this "unusual" baud rate. In Termite, type this value (`74880`) in the baud rate selection text box when configuring the port. Having the option to specify this unusual baud rate will allow you to view the [ESP8266 boot ROM log](https://github.com/espressif/esptool/wiki/ESP8266-Boot-ROM-Log) while the device is booting.

Expand Down
2 changes: 1 addition & 1 deletion docs/HM-10.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ If you have supported Bluetooth devices in range, they will soon be discovered a
`HM10Baud 9600` (sets 9600 baud rate on Tasmota side) then `HM10AT RENEW` (reset HM10 to factory settings which should use 115200 baud rate on newer firmware)
and reboot Tasmota. If that doesn't solve it you will have to connect to the HM-10 with serial-to-USB adapter and set the baudrate in a terminal using commands `AT+RENEW` then `AT+BAUD?`. If the output is 4 baudrate is properly set to 115200, if not use `AT+BAUD4`

For a complete overview of supported devices, commands and features read the [Bluetooth article](Bluetooth#ble-sensors-using-hm-1x)
For a complete overview of supported devices, commands and features read the [Bluetooth article](Bluetooth#using-hm-1x)

### Tasmota Settings for iBeacon

Expand Down
2 changes: 1 addition & 1 deletion docs/Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Some devices use the serial port to control the relays or an MCU, so serial logg

The default logging level for SerialLog logging is 2. Unless explicitly set by a command (e.g., user input in the Console, a System#Boot triggered rule), SerialLog will be disabled automatically 10 minutes after the device reboots.

Through a [terminal program](Getting-Started#serial-terminal) set the baud rate to 115200 (19200 for Sonoff Dual), both NL & CR, and disable hardware flow control.
Through a [terminal program](Getting-Started#__tabbed_2_3) set the baud rate to 115200 (19200 for Sonoff Dual), both NL & CR, and disable hardware flow control.

- Debugging the Sonoff Pow is a bit tricky as the serial interface has a **direct connection to one of the AC power lines**. The schematic below uses two optocouplers separating the AC connection on the **left** from the low voltage connection on the **right** allowing for serial control at 115200 baud and uploading of firmware up to 57600 baud while AC is connected.
<img alt="OptoSerial" src="../_media/OptoSerial.jpg" />
Expand Down

0 comments on commit 005f9f6

Please sign in to comment.