Skip to content

Commit

Permalink
link to Commands.md directly
Browse files Browse the repository at this point in the history
  • Loading branch information
blakadder committed Oct 17, 2023
1 parent 24350d3 commit edc2516
Show file tree
Hide file tree
Showing 26 changed files with 61 additions and 61 deletions.
2 changes: 1 addition & 1 deletion docs/Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -678,7 +678,7 @@ IRSend`<x>`<a class="cmnd" id="irsend"></a>|Send an IR remote control code as a
Command|Parameters
:---|:---
IRSend`<x>`<a id="irsendx"></a>|`<x>` [_optional_] = number of times the IR message is sent. If not specified or `0..1`, the message is sent only once (i.e., not repeated) _(default)_<BR>`>1` = emulate a long-press on the remote control, sending the message `<x>` times, or sending a repeat message for specific protocols (like NEC)<BR><BR>`{"Protocol":"<value>","Bits":<value>,"Data":<value>,"DataLSB":<value>,"Repeat":<value>}`<BR><BR>`"Protocol"` or `"Vendor"` (select one of the following): <BR>`RC5, RC6, NEC, SONY, PANASONIC, JVC, SAMSUNG, WHYNTER, AIWA_RC_T501, LG, MITSUBISHI, DISH, SHARP, DENON, SHERWOOD, RCMM, SANYO_LC7461, RC5X, NEC (non-strict), NIKAI, MAGIQUEST, LASERTAG, CARRIER_AC, MITSUBISHI2, HITACHI_AC1, HITACHI_AC2, GICABLE, LUTRON, PIONEER, LG2, SAMSUNG36, LEGOPF, INAX, DAIKIN152`<BR><BR>`"Bits":1..64` = required number of data bits<BR>&nbsp;&nbsp;&nbsp;&nbsp;for PANASONIC protocol this parameter is the the address, not the number of bits<BR><BR>`"Data":0x1..0xFFFFFFFFFFFFFFFF` = data frame as 64 bit hexadecimal.<BR>&nbsp;&nbsp;&nbsp;&nbsp;e.g., `IRSend {"Protocol":"NEC","Bits":32,"Data":0x8166817E}`<BR>**Or**<BR>`"DataLSB":0x1..0xFFFFFFFFFFFFFFFF` = data frame as 64 bit hexadecimal with LSB (each byte with bits reversed).<BR>&nbsp;&nbsp;&nbsp;&nbsp;e.g., `IRSend {"Protocol":"NEC","Bits":32,"Data":0x8166817E}`<BR>`DataLSB` comes handy with LSB-first (Least Significant Bit First) protocols like NEC, and makes decoding/encoding easier.<BR><BR>`"Repeat":0..<x>` if `0` send the frame once, if `>0` simulates a long press; Note: `"Repeat":1` sends the message twice.<BR><BR>Alternatively, you can send IR remote control codes using [RAW command encoding](IRSend-RAW-Encoding).
|See also<BR>[`SetOption29`](Commands#setoption29) - Set IR received data format<BR>[`SetOption38`](Commands#setoption38) - Set IR received protocol sensitivity<BR>[`SetOption58`](Commands#setoption58) - [IR Raw data in JSON payload](https://github.com/arendst/Tasmota/issues/2116#issuecomment-440716483)
|See also<BR>[`SetOption29`](Commands.md#setoption29) - Set IR received data format<BR>[`SetOption38`](Commands.md#setoption38) - Set IR received protocol sensitivity<BR>[`SetOption58`](Commands.md#setoption58) - [IR Raw data in JSON payload](https://github.com/arendst/Tasmota/issues/2116#issuecomment-440716483)
IRHVAC<a id="irhvac"></a>|Send HVAC IR remote control code as JSON payload<BR><BR>```IRHVAC {"Vendor":"Mitsubishi_Heavy_152", "Power":"On","Mode":"Hot","FanSpeed":3,"Temp":22.5}```<BR><BR>`"Protocol"` or `"Vendor"` (select one of the following): <BR>`COOLIX, DAIKIN, KELVINATOR, MITSUBISHI_AC, GREE, ARGO, TROTEC, TOSHIBA_AC, FUJITSU_AC, MIDEA, HAIER_AC, HITACHI_AC, HAIER_AC_YRW02, WHIRLPOOL_AC, SAMSUNG_AC, ELECTRA_AC, PANASONIC_AC, DAIKIN2, VESTEL_AC, TECO, TCL112AC, MITSUBISHI_HEAVY_88, MITSUBISHI_HEAVY_152, DAIKIN216, SHARP_AC, GOODWEATHER, DAIKIN160, NEOCLIMA, DAIKIN176, DAIKIN128`<BR><BR>`"Model":` Some HVAC have variants in protocols, this field allows to specify the variant, see [detailed list](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md).<BR><UL><LI>`Fujitsu_AC`: `ARRAH2E|ARDB1`</LI><LI>`Panasonic_AC`: `LKE|NKE|DKE|JKE|CKP|RKR`</LI><LI>`Whirlpool_AC`: `DG11J13A|DG11J104|DG11J1-04|DG11J191`</LI></UL>`"Power"`:<UL><LI>`On, Yes, True, 1`</LI><LI>`Off, No, False, 0`</LI></UL>`"Mode"`:<UL><LI>`Off, Stop`</LI><LI>`Auto, Automatic`</LI><LI>`Cool, Cooling`</LI><LI>`Heat, Heating`</LI><LI>`Dry, Drying, Dehumidify`</LI><LI>`Fan, Fanonly, Fan_Only`</LI></UL>`"FanSpeed"`:<UL><LI>`Auto, Automatic`</LI><LI>`Min, Minimum, Lowest, 1`</LI><LI>`Low, 2`</LI><LI>`Med, Medium, Mid, 3`</LI><LI>`High, Hi, 4`</LI><LI>`Max, Maximum, Highest, 5`</LI></UL>`"SwingV"`: vertical swing of Fan<UL><LI>`Auto, Automatic, On, Swing`</LI><LI>`Off, Stop`</LI><LI>`Min, Minimum, Lowest, Bottom, Down`</LI><LI>`Low`</LI><LI>`Mid, Middle, Med, Medium, Centre, Center`</LI><LI>`High, Hi`</LI><LI>`Highest, Max, Maximum, Top, Up`</LI></UL>`"SwingH"`: horizontal swing of Fan<UL><LI>`Auto, Automatic, On, Swing`</LI><LI>`Off, Stop`</LI><LI>`LeftMax, Left Max, MaxLeft, Max Left, FarLeft, Far Left`</LI><LI>`Left`</LI><LI>`Mid, Middle, Med, Medium, Centre, Center`</LI><LI>`Right`</LI><LI>`RightMax, Right Max, MaxRight, Max Right, FarRight, Far Right`</LI><LI>`Wide`</LI></UL>`"Celsius"`: temperature is in Celsius (`"On"`) or Fahrenheit (`"Off"`)<BR>`"Temp"`: Temperature, can be float if supported by protocol<BR>`"Quiet"`: Quiet mode (`"On"` / `"Off"`)<BR>`"Turbo"`: Turbo mode (`"On"` / `"Off"`)<BR>`"Econo"`: Econo mode (`"On"` / `"Off"`)<BR>`"Light"`: Light (`"On"` / `"Off"`)<BR>`"Filter"`: Filter active (`"On"` / `"Off"`)<BR>`"Clean"`: Clean mode (`"On"` / `"Off"`)<BR>`"Beep"`: Beep active (`"On"` / `"Off"`)<BR>`"Sleep"`: Timer in seconds<BR>`"StateMode"`:<UL><LI>`SendOnly` (default)</LI><LI>`StoreOnly`</LI><LI>`SendStore`</LI></UL>
|See also<BR>[`SetOption29`](#setoption29) - Set IR received data format<BR>[`SetOption38`](#setoption38) - Set IR received protocol sensitivity<BR>[`SetOption58`](#setoption58) - [IR Raw data in JSON payload](https://github.com/arendst/Tasmota/issues/2116#issuecomment-440716483)

Expand Down
4 changes: 2 additions & 2 deletions docs/DeepSleep.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
DeepSleep support for up to 10 years (i.e., 86,400 seconds = 1 day) (e.g., if used with KNX) ([`DeepSleepTime`](Commands#deepsleeptime)).
DeepSleep support for up to 10 years (i.e., 86,400 seconds = 1 day) (e.g., if used with KNX) ([`DeepSleepTime`](Commands.md#deepsleeptime)).

`DeepSleepTime` sets the time the device remains in DeepSleep before it returns to full operating mode. Once the command is issued, the DeepSleep cycle commences. During DeepSleep, the device is effectively **off** and, as such, it is not possible to modify DeepSleepTime without exiting DeepSleep.

Expand Down Expand Up @@ -178,7 +178,7 @@ When MQTT connects at `13:08:38`, this sets the system to READY.
13:08:44 CFG: Saved to flash at F4, Count 96, Bytes 3824
```

In the context of DeepSleep, maintaining a device boot count is not relevant. When DeepSleep is enabled, boot count will not be incremented. This avoids excessive flash writes which will deteriorate the flash memory chip and eventually cause the device to fail. Boot count incrementing can be enabled using [`SetOption76`](Commands#setoption76).
In the context of DeepSleep, maintaining a device boot count is not relevant. When DeepSleep is enabled, boot count will not be incremented. This avoids excessive flash writes which will deteriorate the flash memory chip and eventually cause the device to fail. Boot count incrementing can be enabled using [`SetOption76`](Commands.md#setoption76).

In this example, TelePeriod is 10. Therefore when it is reached, telemetry reporting occurs.
```
Expand Down
6 changes: 3 additions & 3 deletions docs/Energy-Saving.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Using the [`Sleep`](Commands#sleep) command you can instruct Tasmota to sleep for the set milliseconds in its main cycle. While sleeping your device will consume less power.
Using the [`Sleep`](Commands.md#sleep) command you can instruct Tasmota to sleep for the set milliseconds in its main cycle. While sleeping your device will consume less power.

[Dynamic Sleep](Dynamic-Sleep) is enabled by default with a value of 50. To continue using Normal Sleep you may disable it by using the command:

[`SetOption60 1`](Commands#setoption60)
[`SetOption60 1`](Commands.md#setoption60)

Setting `Sleep` to lowest value `1` reduces power consumption already about ~30% in idle mode (relay off) and button presses are still noticed without any delay. Setting this around 50 ms reduces power consumption from ~1.1 W to ~0.6 W on an idling (relay off) device and button presses are still noticed correctly. With this setting you have to concentrate very hard to click the button so fast that it is not recognized by the device.

Expand All @@ -12,7 +12,7 @@ If your device needs to do something continuously, this will be affected. E.g.,
> Expect overall button/key/switch misses and wrong values on Sonoff Pow
**Notes:**
- Starting with Tasmota 6.1.1.12 `Sleep` &ne; `0` has no impact on real time related commands like [`Delay`](Commands#delay), [`PulseTime`](Commands#pulsetime), [`TelePeriod`](Commands#teleperiod) and [`Blinktime`](Commands#blinktime).
- Starting with Tasmota 6.1.1.12 `Sleep` &ne; `0` has no impact on real time related commands like [`Delay`](Commands.md#delay), [`PulseTime`](Commands.md#pulsetime), [`TelePeriod`](Commands.md#teleperiod) and [`Blinktime`](Commands.md#blinktime).
- As the WiFi Modem on an ESP8266 is the major consumer - using Sleep with WiFi AP mode enabled is more or less without effect.

## Device power consumption and measurement
Expand Down
2 changes: 1 addition & 1 deletion docs/IRSend-RAW-Encoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ or
If you need to transform the compact format in the legacy format, you can use the online tool: <https://tasmota.hadinger.fr/util>

## IRSend for raw IR
There are two command syntax forms for sending a remote control code in RAW format with [`IRsend`](Commands#irsend):
There are two command syntax forms for sending a remote control code in RAW format with [`IRsend`](Commands.md#irsend):

1. `IRSend<x> <frequency>,<rawdata1>,<rawdata2>,..,<rawdataN>`

Expand Down
2 changes: 1 addition & 1 deletion docs/LedMask.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ LedMask command allows setting a [bitmask](https://en.wikipedia.org/wiki/Mask_(c
`<bitmask>` = [bitwise](https://whatis.techtarget.com/definition/bitwise) value representing each relay. Values may be entered as either hexadecimal or decimal values (e.g., 0xFFFF = 65535).
`0xFFFF` (= 1111 1111 1111 1111) All relays control the power LED _(default)_

*[LedState](Commands#ledstate) must be enabled (i.e., `!= 0`) in order for `LedMask` to take effect.*
*[LedState](Commands.md#ledstate) must be enabled (i.e., `!= 0`) in order for `LedMask` to take effect.*

!!! example "Examples:"

Expand Down
8 changes: 4 additions & 4 deletions docs/Lights.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,23 +334,23 @@ For example, on a Sonoff Basic the green LED is used as the link status LED. Onc

**Link status LED** shows the network state, more specifically the Wi-Fi and MQTT connection status.

It blinks if the device is not connected to your Wi-Fi AP **and** MQTT broker (if MQTT is enabled). You can change this behaviour with [`LedState`](Commands#ledstate) or turn it off with [`SetOption31`](Commands#setoption31).
It blinks if the device is not connected to your Wi-Fi AP **and** MQTT broker (if MQTT is enabled). You can change this behaviour with [`LedState`](Commands.md#ledstate) or turn it off with [`SetOption31`](Commands.md#setoption31).

#### Power status LED
**Power status LED** shows the power status of relay component(s). [`LedMask`](Commands#ledmask) determines which relay(s) are associated with the power status LED. This behavior can be modified with the [`LedState`](Commands#ledstate) command. The LED is turned off by default when the relay is OFF and turned on when the relay switches ON.
**Power status LED** shows the power status of relay component(s). [`LedMask`](Commands.md#ledmask) determines which relay(s) are associated with the power status LED. This behavior can be modified with the [`LedState`](Commands.md#ledstate) command. The LED is turned off by default when the relay is OFF and turned on when the relay switches ON.

!!! note
Depending on the device design, some LEDs are connected to the same GPIO as the relay. Those cannot be independently controlled since they have to follow the relay state.

If you have more than one LED wired independently and you want it to show the power state of the relay, you **must** assign an `LedLink` GPIO.

#### PWM LED Mode
Using [`LedPwmMode`](Commands#ledpwmmode) you can change the LED display mode from simple on/off to a PWM controlled LED which will enable you to f.e. display a brighter LED when the relay is on and a dimmer LED when it's OFF so you can locate the switch in the dark but not have it obnoxiously bright.
Using [`LedPwmMode`](Commands.md#ledpwmmode) you can change the LED display mode from simple on/off to a PWM controlled LED which will enable you to f.e. display a brighter LED when the relay is on and a dimmer LED when it's OFF so you can locate the switch in the dark but not have it obnoxiously bright.

`LedPwmOff` and `LedPwmOn` control the preset LED brightness in their respective states.

#### LedPower Command
When you use [`LedPower`](Commands#ledpower) you take over control of that particular LED and it stops being linked to its corresponding relay and being its power status LED.
When you use [`LedPower`](Commands.md#ledpower) you take over control of that particular LED and it stops being linked to its corresponding relay and being its power status LED.

#### Using LedLink
`LedLink` / `LedLinki` is used to assign the link status LED. If your device does not have an LED for link status (or you want to use that LED for a different purpose), you can assign `LedLink` to an available free GPIO. When `LedLink(i)` is assigned, other LEDs are automatically linked to their corresponding relay and serve as that relay's power status LED - i.e., `Led<x>(i)` links to `Relay<x>(i)`
Expand Down
6 changes: 3 additions & 3 deletions docs/MQTT.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ In the following examples `%topic%` is `tasmota`, FullTopic is `%prefix%/%topic%

- The relay can be controlled with `cmnd/tasmota/POWER on`, `cmnd/tasmota/POWER off` or `cmnd/tasmota/POWER toggle`. Tasmota will send a MQTT status message like `stat/tasmota/POWER ON`.

- Power state message can be sent with the retain flag set using [`PowerRetain 1`](Commands#powerretain).
- Power state message can be sent with the retain flag set using [`PowerRetain 1`](Commands.md#powerretain).

- Telemetry messages can also be sent with the retain flag using [`SensorRetain`](Commands#sensorretain).
- Telemetry messages can also be sent with the retain flag using [`SensorRetain`](Commands.md#sensorretain).

- For Sonoff Dual or Sonoff 4CH the relays need to be addressed with `cmnd/tasmota/POWER<x>`, where {x} is the relay number from 1 to 2 (Sonoff Dual) or from 1 to 4 (Sonoff 4CH). `cmnd/tasmota/POWER4 off` turns off the 4th relay on a Sonoff 4CH.

Expand Down Expand Up @@ -229,7 +229,7 @@ To default maximum MQTT message size that Tasmota can process is 256 bytes. You
```

### Subscribe
Subscribes to an MQTT topic and assigns an [`Event`](Commands#event) name to it.
Subscribes to an MQTT topic and assigns an [`Event`](Commands.md#event) name to it.

`Subscribe <eventName>, <mqttTopic> [, <key>]`

Expand Down
4 changes: 2 additions & 2 deletions docs/NeoPool.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The Tasmota Sugar Valley NeoPool Controller sensor module shows the most of para
![](_media/xsns_83_neopool_s.png)

There are [Tasmota commands](#commands) implemented to control the high level functions for filtration, light and system parameters such as pH set point, hydrolysis level, redox set point etc.
However, the sensor also provides low-level commands to directly [read](#NPRead) and [write](#NPWrite) NeoPool register, means that you have the option to implement your own commands via home automation systems or by using the Tasmota build-in possibilities [Rules](Commands#rules) with [Backlog](Commands#the-power-of-backlog) or the powerful Berry language on ESP32.
However, the sensor also provides low-level commands to directly [read](#NPRead) and [write](#NPWrite) NeoPool register, means that you have the option to implement your own commands via home automation systems or by using the Tasmota build-in possibilities [Rules](Commands.md#rules) with [Backlog](Commands.md#the-power-of-backlog) or the powerful Berry language on ESP32.

## Connection

Expand Down Expand Up @@ -84,7 +84,7 @@ After Tasmota restarts, the main screen should display the controller data as sh

## SENSOR data

Sensor data is sent via the Tasmota topic `tele/%topic%/SENSOR` in JSON format every [TelePeriod](Commands#teleperiod) interval. To get the data immediately, use the Tasmota [TelePeriod](Commands#teleperiod) command without parameter:
Sensor data is sent via the Tasmota topic `tele/%topic%/SENSOR` in JSON format every [TelePeriod](Commands.md#teleperiod) interval. To get the data immediately, use the Tasmota [TelePeriod](Commands.md#teleperiod) command without parameter:

```json
{
Expand Down
4 changes: 2 additions & 2 deletions docs/PCF8574.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Each IO port can be configured as Input or Output in a similar way as a native G

If you are using outputs to drive relays, it is possible to choose if the relay is activated by a
HIGH signal (checkbox "Invert Ports" unchecked) or a LOW signal (checkbox checked). The selection
applies to all output ports. This checkbox can also be controlled by [SetOption81](Commands#setoption81).
applies to all output ports. This checkbox can also be controlled by [SetOption81](Commands.md#setoption81).

Once configuration is complete, it must be saved by clicking on the green "Save" button. Like for
general ESP GPIO configuration, this will trigger a reboot of the ESP.
Expand All @@ -126,7 +126,7 @@ general ESP GPIO configuration, this will trigger a reboot of the ESP.

A PCF8574 pin configured as an output support all features of a Tasmota `Relay` component.

It is assigned a Power index and can be controlled by [Power](Commands#power) command (on, off, toggle).
It is assigned a Power index and can be controlled by [Power](Commands.md#power) command (on, off, toggle).
Power indexes of PCF8574 outputs are assigned after the ESP GPIO configured as `Relay`. For example,
if you have Relay 1 (Power1) to Relay 4 (Power4) configured on the ESP's GPIO, PCF8574 outputs will start at Power5.

Expand Down
Loading

0 comments on commit edc2516

Please sign in to comment.