Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix a few links #1421

Merged
merged 1 commit into from
Oct 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Buttons-and-Switches.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ Multipress functions for 2 and more presses cannot be changed using SetOptions o
`6 short presses`
: Set [`WifiConfig 2`](Commands.md#wificonfig) (start Wi-Fi Manager). Can be disabled using [`SetOption1 1`](Commands.md#setoption1). For [security reasons](Securing-your-IoT-from-hacking.md#disable-unsecured-fallback-wifi-wifimanager), you should change back `WifiConfig` after that.

`**Long press**`
#### `Long press`
: There are two separate functions associated with a button long press based on how long it is held:

1. When held continuously for 40 seconds (Configurable with [SetOption32](Commands.md#setoption32), value is 10x the configured hold time) Tasmota will reset to firmware defaults and restart.
Expand Down
8 changes: 4 additions & 4 deletions docs/Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,8 +168,8 @@ DspLine<1\|2><a class="cmnd" id="dspline"></a>|For POWR3 Elite and THR3 Elite<br
DspSpeed<a class="cmnd" id="dspspeed"></a>|For POWR3 Elite and THR3 Elite<br>`2..127` = control message rotation speed on display
Emulation<a class="cmnd" id="emulation"></a>|`0` = disable emulation *(default)*<BR>`1` = enable Belkin WeMo emulation for [Alexa](Alexa)<BR>`2` = enable Hue Bridge emulation for [Alexa](Alexa)
FriendlyName<x\><a class="cmnd" id="friendlyname"></a>|`1` = Reset friendly name to firmware default<BR>`<value>` = set friendly name (32 char limit)
GPIOs<a class="cmnd" id="gpios"></a>|Show list of available [components](Components#gpio-conversion) by name and index<BR>`255` / `All` Show list of all [components](Components#gpio-conversion) by name and index<BR>
GPIO<a class="cmnd" id="gpio"></a>|Show current [component](Components#gpio-conversion) assignments of the Module's configurable GPIO<BR>`255` / `All` Show [component](Components#gpio-conversion) assignments for all the devices available GPIO<BR>
GPIOs<a class="cmnd" id="gpios"></a>|Show list of available [components](Components#gpio-overview) by name and index<BR>`255` / `All` Show list of all [components](Components#gpio-overview) by name and index<BR>
GPIO<a class="cmnd" id="gpio"></a>|Show current [component](Components#gpio-overview) assignments of the Module's configurable GPIO<BR>`255` / `All` Show [component](Components#gpio-overview) assignments for all the devices available GPIO<BR>
GPIO<x\><a class="cmnd" id="gpiox"></a>|`<component>` = assign a [component](Components) to `Gpio<x>`
GPIORead<x\><a class="cmnd" id="gpioread"></a>|Perform a digitalRead on each configured GPIO to show input state
I2CScan0<a class="cmnd" id="i2cscan0"></a>|*ESP32 only* Scan both I<sup>2</sup>C busses and show addresses for found devices
Expand Down Expand Up @@ -521,7 +521,7 @@ SetOption13<a class="cmnd" id="setoption13"></a>|Allow immediate action on singl
SetOption15<a class="cmnd" id="setoption15"></a>|Set PWM control for LED lights<BR>`0` = basic PWM control<BR>`1` = control with [`Color`](#color) or [`Dimmer`](#dimmer) commands _(default)_
SetOption16<a class="cmnd" id="setoption16"></a>|Set addressable LED Clock scheme parameter<BR> `0` = clock-wise mode *(default)*<BR> `1` = counter-clock-wise mode
SetOption17<a class="cmnd" id="setoption17"></a>|Show [`Color`](#color) string as<BR> `0` = hex string *(default)*<BR> `1` = comma-separated decimal string
SetOption18<a class="cmnd" id="setoption18"></a>|Set status of signal light paired with [CO~2~ sensor](#sensor14)<BR> `0` = disable light *(default)*<BR>`1` = enable light<BR>The light will be green below `CO2_LOW` and red above `CO2_HIGH` (transition yellow/orange between). The default levels are: 800ppm for low and 1200ppm for high but these can be set in `user_config_override.h`.
SetOption18<a class="cmnd" id="setoption18"></a>|Set status of signal light paired with [CO~2~ sensor](#sensor15)<BR> `0` = disable light *(default)*<BR>`1` = enable light<BR>The light will be green below `CO2_LOW` and red above `CO2_HIGH` (transition yellow/orange between). The default levels are: 800ppm for low and 1200ppm for high but these can be set in `user_config_override.h`.
SetOption19<a class="cmnd" id="setoption19"></a>|[Tasmota discovery protocol](Home-Assistant.md) used in Home Assistant [Tasmota integration](https://www.home-assistant.io/integrations/tasmota/)<BR> `0` = enable Tasmota discovery *(default)*<BR> `1` = use deprecated MQTT discovery (only with `#define USE_HOME_ASSISTANT`, does not exist in release binaries)
SetOption20<a class="cmnd" id="setoption20"></a>|Update of Dimmer/Color/CT without turning power on<BR>`0` = disable *(default)*<BR>`1` = enable
SetOption21<a class="cmnd" id="setoption21"></a>|Energy monitoring when power is off<BR>`0` = disable *(default)*<BR>`1` = enable
Expand Down Expand Up @@ -821,7 +821,7 @@ ZbOmitDevice<a class="cmnd" id="zbomitdevice"></a><BR>SetOption119<a class="cmnd
ZbPermitJoin<a class="cmnd" id="zbpermitjoin"></a>|Sets pairing mode for new device discovery<BR>`0` = disable pairing mode<BR>`1` = enable pairing mode for 60 seconds<BR>`99` = enable pairing until device reboots (CC2530 only)<BR>:rotating_light: Leaving Zigbee network open to join will allow any Zigbee device to connect and retrieve your network encryption key. This can lead to a compromise of your Zigbee network.
ZbPing<a class="cmnd" id="zbping"></a>|`<device>` = test availability of Zigbee device. If the device is connected and not sleeping, you should receive a `ZbPing` message within the next second.<BR>Example: `ZbPing 0x5ADF` responds with:<br> `{"ZbPing":{"Device":"0x5ADF","IEEEAddr":"0x90FD9FFFFE03B051"}}`
ZbReceivedTopic<a class="cmnd" id="zbreceivedtopic"></a><BR>SetOption118<a class="cmnd" id="setoption118"></a>|Move ZbReceived from JSON message into the subtopic replacing "SENSOR" default<BR>`0` = disable *(default)*<BR>`1` = enable
ZbSend<a class="cmnd" id="zbsend"></a>|Command structure: `{"Device":"<shortaddr>", "Endpoint":"<endpoint>", "Manuf":<manuf>, "Send":{"<sendcmd>":<sendparam>}}`<BR>`<shortaddr>` = short address of the Zigbee device on the network<BR>`<endpoint>` = target endpoint on the device ([understanding endpoints](Zigbee#understanding-endpoints-and-clusters))<BR>`<manuf>` = (optional) forces a specific ManufacturerId in the ZCL frame (required by some Xiaomi devices)<BR>`"<sendcmd>":<sendparam>` = command and parameters to send ([Zigbee Device Commands](Zigbee#sending-device-commands))<BR>:notebook: _Use [`ZbZNPSend`](#zbznpsend) to send a raw form low-level message on CC253x gateways _<BR>Example: `ZbSend { "Device":"0x1234", "Endpoint":"0x03", "Send":{"Power":"on"} }`
ZbSend<a class="cmnd" id="zbsend"></a>|Command structure: `{"Device":"<shortaddr>", "Endpoint":"<endpoint>", "Manuf":<manuf>, "Send":{"<sendcmd>":<sendparam>}}`<BR>`<shortaddr>` = short address of the Zigbee device on the network<BR>`<endpoint>` = target endpoint on the device ([understanding endpoints](Zigbee#advanced-topic-endpoints-and-clusters))<BR>`<manuf>` = (optional) forces a specific ManufacturerId in the ZCL frame (required by some Xiaomi devices)<BR>`"<sendcmd>":<sendparam>` = command and parameters to send ([Zigbee Device Commands](Zigbee#sending-device-commands))<BR>:notebook: _Use [`ZbZNPSend`](#zbznpsend) to send a raw form low-level message on CC253x gateways _<BR>Example: `ZbSend { "Device":"0x1234", "Endpoint":"0x03", "Send":{"Power":"on"} }`
ZbScan<a class="cmnd" id="zbscan"></a>|Do an energy scan on each radio channel
ZbStatus<x\><a class="cmnd" id="zbstatus"></a>|Display Zigbee devices seen on the network since boot<BR>`<device>` (optional)<BR>` ` = all devices<BR>This command provides three levels of increasing detail according to `<x>`<BR>`ZbStatus1` Display Short Address, and Friendly Name<BR>`ZbStatus2` Also include Manufacturer ID and Model ID<BR>`ZbStatus3` Also include a list of endpoints and the clusterIds supported by each endpoint<BR>Example: `ZbStatus3 1` requests all details for device number 1<BR>:notebook: Requested information may exceed maximum result size allowed by Tasmota. In this case, the output will be truncated. To get all of the desired information, request results for a specific device individually.
ZbUnbind<a class="cmnd" id="zbunbind"></a>|Unbinds one Zigbee device from another or from a group. <BR>`{"Device":"<device>", "Endpoint":<endpoint>, "Cluster":<cluster>, "ToDevice":"<to_device>", "ToEndpoint":<to_endpoint>, "ToGroup":<to_group> }`<BR>`<device>` = the device sending the messages **(mandatory)**<BR>`<endpoint>` = the source endpoint **(mandatory)**<BR>`<cluster>` = the source cluster id **(mandatory)**<BR>`<to_device>` = the target device (optional)<BR>`<to_endpoint>` = the target endpoint (optional if it can be inferred from `ZbStatus3`)<BR>`<to_group>` = the target group id (optional)<BR>:notebook: You must specify either `"ToDevice"` or `"ToGroup"` but not both<BR>:notebook: Zigbee2Tasmota must know the IEEE address of the target device, use `ZbStatus2` to verify and `ZbProbe` to query the address.
Expand Down
2 changes: 1 addition & 1 deletion docs/DS18x20.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Shelly dual pin mode is supported by an additional pin assignment:

[`SetOption126`](Commands.md#setoption126) Enable arithmetic mean over teleperiod for JSON temperature for DS18x20 sensors.

[`TempRes`](Commands.md#TempRes) Temperature sensor resolution: 0..3 = maximum number of decimal places.
[`TempRes`](Commands.md#tempres) Temperature sensor resolution: 0..3 = maximum number of decimal places.

[`TempOffset`](Commands.md#tempoffset) can be used to add/sub an offset to the measured temperature. This setting affects **all** temperature sensors on the device.

Expand Down
8 changes: 4 additions & 4 deletions docs/Lights.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ If you define multiple relays, they are controlled with [`Power<x>`](Commands.md
|Channel3| PWM3 (optional)|
|Channelxx| PWMxx (optional)|
|Zero-Cross PIN| COUNTER4 (mandatory)|
|Commands|[`ZCDimmerSet`](Commands.md#zcdimmerset) ESP32 only|
|Commands| `ZCDimmerSet`|

Example schematic:
![ZCDimmer example schematic](_media/peripherals/ZCDimmer_Schematic.png)
Expand Down Expand Up @@ -102,7 +102,7 @@ If you define multiple relays, they are controlled with [`Power<x>`](Commands.md
|Configuration|(see below)|
|---|---|
|Commands|[`Power`](Commands.md#power), [`Dimmer`](Commands.md#dimmer), [`Color`](Commands.md#color), [`White`](Commands.md#white), [`CT`](Commands.md#ct)|
|Options|[**Auto Power On**](#disable-auto-power-on), [**PWM Channel Configuration**](#pwm-channel-configuration), [**Gamma Correction**](#gamma-correction), [**PWM CT**](#pwm-ct-module-48)|
|Options|[**Auto Power On**](#disable-auto-power-on), [**PWM Channel Configuration**](#pwm-channel-configuration), [**Gamma Correction**](#gamma-correction), [**PWM CT**](#pwm-ct)|

<br clear="right"/>

Expand Down Expand Up @@ -255,13 +255,13 @@ _this feature is experimental and will probably not give brilliant results_

Used with 4 channel RGBW lights to simulate the missing white channel (cold or warm) using RGB channels.

Enable Virtual CT with [`SetOption106 1`](Commands.md#setoption106) then choose which type of white you're simulating with [`SetOption107`](Commands.md#setoption107) where `0` is warm white and `1` is cold white
Enable Virtual CT with `SetOption106 1` then choose which type of white you're simulating with [`SetOption107`](Commands.md#setoption107) where `0` is warm white and `1` is cold white

## Light Categories

Lights come in various shapes (bulb, strips, ceiling lights, ...) but in Tasmota they are separated in 3 categories:

- [Channel Controlled LEDs](#channel-controlled-leds)
- [Channel Controlled Lights](#channel-controlled-lights)
- [Addressable LEDs](#addressable-leds)
- [Status LEDs](#status-leds)

Expand Down
2 changes: 1 addition & 1 deletion docs/Matter.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ This will bring you to another menu where you can further configure the remote d

![Add Remote Tasmota or OpenBK submenu](_media/matter/add_remote_submenu.jpg)

Add remote [Endpoints](#endpoint) same as for a local sensors and devices.
Add remote Endpoints same as for a local sensors and devices.

When finished click ***Add endpoints***. The remote device will appear in the ***Current configuration*** list.

Expand Down
2 changes: 1 addition & 1 deletion docs/NRF24L01.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ The initial log should like this:
The driver will do the rest automatically and start to look for known "special" packets, which will be used to extract the sensor readings.
webUI and TELE-messages will be populated with sensor data. This can take a while after start and may be influenced by the general traffic on the 2,4 GHz band.

For a complete overview of supported devices, commands and features read the [Bluetooth article](Bluetooth.md#ble-sensors-using-nrf24l01).
For a complete overview of supported devices, commands and features read the [Bluetooth article](Bluetooth.md#using-nrf24l01).
4 changes: 2 additions & 2 deletions docs/NeoPool.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ Relays|(Int) These subkeys list the relay number assignments to the internal fun

This sensor supports some high-level [commands](#commands) for end user.

Regardless, all other Modbus registers can be read and write, so you can [enhance](#Enhancements) your Sugar Valley control by using low-level [NPRead](#NPRead)/[NPWrite](#NPWrite) commands.
Regardless, all other Modbus registers can be read and write, so you can [enhance](#enhancements) your Sugar Valley control by using low-level [NPRead](#NPRead)/[NPWrite](#NPWrite) commands.

Modbus register addresses and their meaning are described within source file [xsns_83_neopool.ino](https://github.com/arendst/Tasmota/blob/development/tasmota/xsns_83_neopool.ino) at the beginning and (partly) within document [171-Modbus-registers](https://downloads.vodnici.net/uploads/wpforo/attachments/69/171-Modbus-registers.pdf).<BR>
Please note that Sugar Valley Modbus registers are not byte addresses but modbus registers containing 16-bit values - don't think in byte memory layout.
Expand All @@ -371,7 +371,7 @@ NPHydrolysis<a id="NPHydrolysis"></a>|`<level>( %)`<BR>Set hydrolysis/electrolys
NPIonization<a id="NPIonization"></a>|`<level>`<BR>Set ionization target production level (level = `0..<max>`, the upper limit `<max>` may vary depending on the [MBF_PAR_ION_NOM](https://github.com/arendst/Tasmota/blob/development/tasmota/tasmota_xsns_sensor/xsns_83_neopool.ino#L140) register)<BR>Note: The command is only available if the hydrolysis/electrolysis control is present.
NPChlorine<a id="NPChlorine"></a>|`<setpoint>`<BR>Set chlorine setpoint in ppm (setpoint = `0..10`)<BR>Note: The command is only available if the free chlorine probe detector is installed.
NPControl<a id="NPControl"></a>|Show information about [system controls](NeoPool#sensor-data-description).
NPTelePeriod<a id="NPTelePeriod"></a>|`<time>`<BR>Enables/disables auto telemetry message when NeoPool values change (time = `0` or `5..3600`):<ul><li>`0` - disable this function off (default), telemetry message are only reported depending on [TelePeriod](#teleperiod) setting</li><li>`5..3600` - set the minimum of seconds between two telemetry messages for NeoPool measured values (status changes for relays and settings trigger the SENSOR messages immediately, regardless of the time set)</li></ul>Hint: To get immediate telemetry messages only for status changes (relays, settings) set `<time>` higher than [TelePeriod](#teleperiod). In this case, measured sensors are reported only by [TelePeriod](#teleperiod) setting, status changes are reported immediately.
NPTelePeriod<a id="NPTelePeriod"></a>|`<time>`<BR>Enables/disables auto telemetry message when NeoPool values change (time = `0` or `5..3600`):<ul><li>`0` - disable this function off (default), telemetry message are only reported depending on [TelePeriod](Commands.md#teleperiod) setting</li><li>`5..3600` - set the minimum of seconds between two telemetry messages for NeoPool measured values (status changes for relays and settings trigger the SENSOR messages immediately, regardless of the time set)</li></ul>Hint: To get immediate telemetry messages only for status changes (relays, settings) set `<time>` higher than [TelePeriod](Commands.md#teleperiod). In this case, measured sensors are reported only by [TelePeriod](Commands.md#teleperiod) setting, status changes are reported immediately.
NPOnError<a id="NPOnError"></a>|`<repeat>`<BR>Set the number of retries for Modbus read/write commands errors (repeat = `0..10`):<ul><li>`0` - disable auto-repeat on read/write error</li><li>`1..10` - repeat commands n times until ok</li></ul>
NPResult<a id="NPResult"></a>|`<format>`<BR>Set addr/data result format for read/write commands (format = `0|1`):<ul><li>`0` - output decimal numbers</li><li>`1` - output hexadecimal strings, this is the default</li></ul>
NPPHRes<a id="NPPHRes"></a>|`<resolution>`<BR>Set number of decimal places in results for PH value (resolution = `0..3`).
Expand Down
2 changes: 1 addition & 1 deletion docs/Peripherals.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ _[`GPIOs All`](Commands.md#gpios) shows list of all available components by name
**For a peripheral to show up you may need to power cycle your device instead of a soft restart.**

### `Template`
Instead of using `Module` and `GPIO` you can define everything using `Template`. [Read more...](Templates#template-configuration-with-commands)
Instead of using `Module` and `GPIO` you can define everything using `Template`. [Read more...](Templates#commands)

## Additional Options

Expand Down
2 changes: 1 addition & 1 deletion docs/TM163x.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ After the ESP8266/ESP32 module restarts again, the display module is ready to ac

### DisplayModes

[DisplayModes](Displays.md#displaymode-parameters) `0..3` are supported. The firmware default is `DisplayMode 1`.
[DisplayModes](Displays.md#displaymode) `0..3` are supported. The firmware default is `DisplayMode 1`.

To use the Seven-Segment specific _Display-_ commands described below, set the `DisplayMode` to `0` with:

Expand Down
2 changes: 1 addition & 1 deletion docs/TM1650.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ After the ESP8266/ESP32 module restarts again, the display module is ready to ac

### DisplayModes

[DisplayModes](Displays.md#displaymode-parameters) `0..3` are supported. The firmware default is `DisplayMode 1`.
[DisplayModes](Displays.md#displaymode) `0..3` are supported. The firmware default is `DisplayMode 1`.

To use the Seven-Segment specific _Display-_ commands described below, set the `DisplayMode` to `0` with:

Expand Down
2 changes: 1 addition & 1 deletion docs/TuyaMCU.md
Original file line number Diff line number Diff line change
Expand Up @@ -609,7 +609,7 @@ The MCU communicates with the Wi-Fi module through the serial port with a Tuya s
They are common protocols integrated in Tasmota's TuyaMCU module. They stay the same for each product and are mandatory for Tuya module to work correctly.

## Functional protocols
Functional protocols are used for delivering and reporting data of functions. These protocols differ between devices and manufacturers and might require configuration in Tasmota using [`TuyaMCU`](#tuyamcu) command or with [`TuyaSend<x>`](#tuyasend) command.
Functional protocols are used for delivering and reporting data of functions. These protocols differ between devices and manufacturers and might require configuration in Tasmota using [`TuyaMCU`](Commands.md#tuyamcu) command or with [`TuyaSend<x>`](Commands.md#tuyasend) command.

## Anatomy of Tuya Protocol

Expand Down
2 changes: 1 addition & 1 deletion docs/Zigbee.md
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ To remove a device from the Zigbee2Tasmota list of devices and from the WebUI, u

### Advanced topic: Device Information

You can get a quick list of Zigbee devices with the command [`ZbStatus`](Commands.md#zigbeestatus).
You can get a quick list of Zigbee devices with the command [`ZbStatus`](Commands.md#zbstatus).

Example:

Expand Down
Loading