Merge branch 'master' of https://github.com/arendst/Tasmota.wiki

blakadder 2019-11-06 21:09:43 +01:00
commit 9579df7436
2 changed files with 8 additions and 23 deletions

@ -30,23 +30,8 @@ Shutter accuracy digits: 1
Shutter 0 (Relay:1): Init. Pos: 20000 [100 %], Open Vel.: 100 Close Vel.: 100 , Max Way: 20000, Opentime 10.0 [s], Closetime 10.0 [s], CoedffCalc: c0: 0, c1 200, c2: 200, c3: 0, c4: 0, binmask 3, is inverted 1, ShutterMode 0, motordelay 0 Shutter 0 (Relay:1): Init. Pos: 20000 [100 %], Open Vel.: 100 Close Vel.: 100 , Max Way: 20000, Opentime 10.0 [s], Closetime 10.0 [s], CoedffCalc: c0: 0, c1 200, c2: 200, c3: 0, c4: 0, binmask 3, is inverted 1, ShutterMode 0, motordelay 0
``` ```
## Shutter Commands ## Operation
Refer to the [Blinds, Shutters and Roller Shades Commands](Commands#blinds-shutters-and-roller-shades)
Command<BR> (x = `1..4`)|Parameters
-|-
ShutterCalibration\<x><a id="ShutterCalibration"></a>|Granular shutter position calibration. Real position in cm must be put in at 30 50 70 90 percent
ShutterCloseDuration\<x><a id="ShutterCloseDuration"></a>| `1..255` *(default = `10`)*<BR>Define the time, in seconds, it takes to fully close the shutter. A fraction of a second can be specified (e.g. `45.7`).
ShutterClose\<x><a id="ShutterClose"></a>|Engage the relay to close the shutter. This action can be requested at any time.
ShutterInvert\<x><a id="ShutterInvert"></a>|`0` = use default shutter positioning<BR>`1` = invert shutter positioning
ShutterMotorDelay\<x><a id="ShutterMotorDelay"></a>|`0.00 .. 12.75` sec *(default = `0`)*<BR>Define the time, in seconds, that it takes the motor to start moving once power is turned on.
ShutterOpenDuration\<x><a id="ShutterOpenDuration"></a>|`1..255` *(default = `10`)*<BR>time, in seconds, to fully open the shutter. Fraction of a second can be specified (e.g. `45.7`).
ShutterOpen\<x><a id="ShutterOpen"></a>|Engage the relay to open the shutter. This action can be requested at any time.
ShutterPosition\<x><a id="ShutterPosition"></a>|`0..100`<BR>`0` = Closed, `100` = Open<BR>If the shutter is inverted (e.g., if used with KNX), `100` = Closed, `0` = Open<BR>A shutter position change can be requested at any time. The shutter will stop and revert or update to the requested position. The shutter's actual position will be saved _**after**_ the movement is completed. In this case, the position will be restored during reboot. An interruption during shutter movement (e.g., a device restart) will lose the current position.
ShutterRelay\<x><a id="ShutterRelay"></a>|`<value>`<BR>`0` = disable this and all higher numbered shutters<BR>`1,3,5,7,...` (must be an odd number) = define the `Relay<value>` component used to open the shutter. This relay's mate, the next higher numbered relay, closes the shutter. Depending on the shutter mode, the relays may need to be interlocked using the [`Interlock`](Commands#interlock) command.<BR>**The `ShutterRelay` command must be executed first before any other shutter commands for `Shutter<x>` can be executed.**
ShutterSetClose\<x><a id="ShutterSetClose"></a>|Set the shutter closed position. `ShutterPosition` will be reset to fully closed value (e.g., `0` when `ShutterInvert = 0`, `100` otherwise).
ShutterSetHalfway\<x><a id="ShutterSetHalfway"></a>| `0..100` *(default = `50`)*<BR>Define shutter half open position (in percent)
ShutterStop\<x><a id="ShutterStop"></a>|Disengage the relays to stop the shutter
See also| [`SetOption80`](#SetOption80) - Enable shutter support
Turning a device relay on or off directly (i.e., using `Power`) will function to affect a shutter's movement. In momentary mode (i.e., stepper motor), the relays start or stop the motor. The driver takes care of the direction and proper update of the shutter position. Turning a device relay on or off directly (i.e., using `Power`) will function to affect a shutter's movement. In momentary mode (i.e., stepper motor), the relays start or stop the motor. The driver takes care of the direction and proper update of the shutter position.

@ -12,7 +12,7 @@
- [IR Remote](#ir-remote) - [IR Remote](#ir-remote)
- [SetOption overview](#setoption-overview) - [SetOption overview](#setoption-overview)
- [Serial Bridge](#serial-bridge) - [Serial Bridge](#serial-bridge)
- [mp3-player](#mp3-player) - [MP3 Player](#mp3-player)
- [Domoticz](#domoticz) - [Domoticz](#domoticz)
- [KNX](#knx) - [KNX](#knx)
- [Displays](#displays) - [Displays](#displays)
@ -414,7 +414,7 @@ SetOption61<a id="SetOption61"></a>|Force [local operation](https://github.com/a
SetOption62<a id="SetOption62"></a>|Set retain on Button or Switch hold messages&emsp; »6.4.1.19<BR>`0` = disable *(default)*<BR> `1` = don't use retain flag on `HOLD` messages SetOption62<a id="SetOption62"></a>|Set retain on Button or Switch hold messages&emsp; »6.4.1.19<BR>`0` = disable *(default)*<BR> `1` = don't use retain flag on `HOLD` messages
SetOption63<a id="SetOption63"></a>|Set relay state feedback scan at restart ([#5594](../issues/5594), [#5663](../issues/5663))&emsp; »6.5.0.9<BR>`0` = Scan relay power feedback state at restart *(default)*<BR> `1` = Disable relay power feedback state scanning at restart SetOption63<a id="SetOption63"></a>|Set relay state feedback scan at restart ([#5594](../issues/5594), [#5663](../issues/5663))&emsp; »6.5.0.9<BR>`0` = Scan relay power feedback state at restart *(default)*<BR> `1` = Disable relay power feedback state scanning at restart
SetOption64<a id="SetOption64"></a>|Switch between `-` or `_` as sensor name separator&emsp; »6.5.0.12<BR>`0` = sensor name index separator is `-` _(hyphen)_ *(default)*<BR> `1` = sensor name index separator is `_` _(underscore)_<br>*Affects DS18X20, DHT, BMP and SHT3X sensor names in tele messages* SetOption64<a id="SetOption64"></a>|Switch between `-` or `_` as sensor name separator&emsp; »6.5.0.12<BR>`0` = sensor name index separator is `-` _(hyphen)_ *(default)*<BR> `1` = sensor name index separator is `_` _(underscore)_<br>*Affects DS18X20, DHT, BMP and SHT3X sensor names in tele messages*
SetOption65<a id="SetOption65"></a>|Control [fast power cycle detection](Fast-power-cycle-device-recovery)&emsp; »6.7.1<BR>`0` = fast power cycling is active *(default)*<BR>`1` = fast power cycling is **not** active SetOption65<a id="SetOption65"></a>|Control [fast power cycle detection](Fast-power-cycle-device-recovery) device recovery&emsp; »6.7.1<BR>`0` = detection is active *(default)*<BR>`1` = detection is **inactive**
SetOption66<a id="SetOption66"></a>|Set publishing TuyaReceived to MQTT&emsp; »6.7.0<BR>`0` = disable publishing `TuyaReceived` over MQTT *(default)*<BR>`1` = enable publishing `TuyaReceived` over MQTT SetOption66<a id="SetOption66"></a>|Set publishing TuyaReceived to MQTT&emsp; »6.7.0<BR>`0` = disable publishing `TuyaReceived` over MQTT *(default)*<BR>`1` = enable publishing `TuyaReceived` over MQTT
SetOption67<a id="SetOption67"></a>|iFan03 Buzzer control&emsp; »6.6.0.2<BR>`0` = disable Sonoff iFan03 buzzer *(default)*<BR>`1` = enable Sonoff iFan03 buzzer SetOption67<a id="SetOption67"></a>|iFan03 Buzzer control&emsp; »6.6.0.2<BR>`0` = disable Sonoff iFan03 buzzer *(default)*<BR>`1` = enable Sonoff iFan03 buzzer
SetOption68<a id="SetOption68"></a>|Multi-channel PWM instead of a single light&emsp; »6.6.0.3<BR>`0` = Treat [PWM](#pwm) as a single light *(default)*<BR>`1` = Treat [PWM](#pwm) as separate channels. In this mode, use [`Power<x>`](#power) to turn lights on and off, and [`Channel<x>`](#channel) to change the value of each channel.<BR>[`Color`](#color) still works to set all channels at once.<BR>***Requires restart after change*** SetOption68<a id="SetOption68"></a>|Multi-channel PWM instead of a single light&emsp; »6.6.0.3<BR>`0` = Treat [PWM](#pwm) as a single light *(default)*<BR>`1` = Treat [PWM](#pwm) as separate channels. In this mode, use [`Power<x>`](#power) to turn lights on and off, and [`Channel<x>`](#channel) to change the value of each channel.<BR>[`Color`](#color) still works to set all channels at once.<BR>***Requires restart after change***
@ -445,7 +445,7 @@ SerialSend\<x><a id="SerialSend"></a>|`<string>`<BR>Disable serial logging and s
SSerialSend\<x><a id="SSerialSend"></a>|`<string>`<BR>Send using software serial protocol<BR>x = `1..5`<BR>`1` = send appending `\n` (newline) ()<BR>`2` = send<BR>`3` = replace escape characters and send &emsp; »6.5.0<BR>`4` = send as binary data. Data in serial response messages is encoded as hex strings<BR>`5` = send as hex. Data in serial response messages is encoded as hex strings &emsp; »6.5.0 SSerialSend\<x><a id="SSerialSend"></a>|`<string>`<BR>Send using software serial protocol<BR>x = `1..5`<BR>`1` = send appending `\n` (newline) ()<BR>`2` = send<BR>`3` = replace escape characters and send &emsp; »6.5.0<BR>`4` = send as binary data. Data in serial response messages is encoded as hex strings<BR>`5` = send as hex. Data in serial response messages is encoded as hex strings &emsp; »6.5.0
TuyaSend\<x><a id="TuyaSend"></a>|Send data to MCU with [TuyaMCU](TuyaMCU)&emsp; » v7.0.0.1<br>x = `1..4`<br>`TuyaSend1 <dpId>,<boolean>` = send boolean (`0`/`1`) data type to dpId (1 byte max length)<br>`TuyaSend2 <dpId>,<int>` = send integer data to dpId (4 bytes max length)<br>`TuyaSend2 <dpId>,<0xAABBCCDD>` = send 4 byte data to dpId (4 bytes max length)<br>`TuyaSend3 <dpId>,<value>` = send any data type to dpId (unknown max length)<br>`TuyaSend4 <dpId>,<enum>` = send enumerated (`0`/`1`/`2`/`3`/`4`/`5`) data type to dpId (1 byte max length)<br> TuyaSend\<x><a id="TuyaSend"></a>|Send data to MCU with [TuyaMCU](TuyaMCU)&emsp; » v7.0.0.1<br>x = `1..4`<br>`TuyaSend1 <dpId>,<boolean>` = send boolean (`0`/`1`) data type to dpId (1 byte max length)<br>`TuyaSend2 <dpId>,<int>` = send integer data to dpId (4 bytes max length)<br>`TuyaSend2 <dpId>,<0xAABBCCDD>` = send 4 byte data to dpId (4 bytes max length)<br>`TuyaSend3 <dpId>,<value>` = send any data type to dpId (unknown max length)<br>`TuyaSend4 <dpId>,<enum>` = send enumerated (`0`/`1`/`2`/`3`/`4`/`5`) data type to dpId (1 byte max length)<br>
### mp3-player ### MP3 Player
» v6.6.0 » v6.6.0
The MP3 Player driver is based on the one from DFRobot. They named it [DFPlayer mini](https://www.dfrobot.com/wiki/index.php/DFPlayer_Mini_SKU:DFR0299). All MP3 Players with the identical Serial Control Command structure can be used. The MP3 Player driver is based on the one from DFRobot. They named it [DFPlayer mini](https://www.dfrobot.com/wiki/index.php/DFPlayer_Mini_SKU:DFR0299). All MP3 Players with the identical Serial Control Command structure can be used.
@ -456,8 +456,8 @@ MP3DAC<a id="MP3DAC"></a>|`0` = DAC on *(default)*<BR>`1` = DAC off
MP3Device<a id="MP3Device"></a>|Specify playback device<BR>`1` = USB<BR>`2` = SD Card *(default (also defaults on reset or power cycle))* MP3Device<a id="MP3Device"></a>|Specify playback device<BR>`1` = USB<BR>`2` = SD Card *(default (also defaults on reset or power cycle))*
MP3EQ<a id="MP3EQ"></a>|Set equalizer mode:<BR>`0` = normal<BR>`1` = pop<BR>`2` = rock<BR>`3` = jazz<BR>`4` = classic<BR>`5` = bass) MP3EQ<a id="MP3EQ"></a>|Set equalizer mode:<BR>`0` = normal<BR>`1` = pop<BR>`2` = rock<BR>`3` = jazz<BR>`4` = classic<BR>`5` = bass)
MP3Pause<a id="MP3Pause"></a>|Pause MP3Pause<a id="MP3Pause"></a>|Pause
MP3Play<a id="MP3Play"></a>|Play, works as a normal play on a real MP3 Player, starts at first mp3 file MP3Play<a id="MP3Play"></a>|Play, works as a normal play on a real MP3 Player, starts at first MP3 file
MP3Reset<a id="MP3Reset"></a>|Reset the mp3 player to defaults MP3Reset<a id="MP3Reset"></a>|Reset the MP3 player to defaults
MP3Stop<a id="MP3Stop"></a>|Stop MP3Stop<a id="MP3Stop"></a>|Stop
MP3Track<a id="MP3Track"></a>|`x` = play track \<x\> MP3Track<a id="MP3Track"></a>|`x` = play track \<x\>
MP3Volume<a id="MP3Volume"></a>|`0..100` = set Volume MP3Volume<a id="MP3Volume"></a>|`0..100` = set Volume
@ -547,7 +547,7 @@ ShutterCalibration\<x><a id="ShutterCalibration"></a>|Granular shutter position
ShutterCloseDuration\<x><a id="ShutterCloseDuration"></a>| `1..255` *(default = `10`)*<BR>Define the time, in seconds, it takes to fully close the shutter. A fraction of a second can be specified (e.g. `45.7`). ShutterCloseDuration\<x><a id="ShutterCloseDuration"></a>| `1..255` *(default = `10`)*<BR>Define the time, in seconds, it takes to fully close the shutter. A fraction of a second can be specified (e.g. `45.7`).
ShutterClose\<x><a id="ShutterClose"></a>|Engage the relay to close the shutter. This action can be requested at any time. ShutterClose\<x><a id="ShutterClose"></a>|Engage the relay to close the shutter. This action can be requested at any time.
ShutterInvert\<x><a id="ShutterInvert"></a>|`0` = use default shutter positioning<BR>`1` = invert shutter positioning ShutterInvert\<x><a id="ShutterInvert"></a>|`0` = use default shutter positioning<BR>`1` = invert shutter positioning
ShutterMotorDelay\<x><a id="ShutterMotorDelay"></a>|`0.00 .. 12.75` sec *(default = `0`)*<BR>Define the time, in seconds, that it takes the motor to start moving once power is turned on. ShutterMotorDelay\<x><a id="ShutterMotorDelay"></a>|`0.00 .. 12.75` *(default = `0`)*<BR>Define the time, in seconds, that it takes the motor to start moving once power is turned on.
ShutterOpenDuration\<x><a id="ShutterOpenDuration"></a>|`1..255` *(default = `10`)*<BR>time, in seconds, to fully open the shutter. Fraction of a second can be specified (e.g. `45.7`). ShutterOpenDuration\<x><a id="ShutterOpenDuration"></a>|`1..255` *(default = `10`)*<BR>time, in seconds, to fully open the shutter. Fraction of a second can be specified (e.g. `45.7`).
ShutterOpen\<x><a id="ShutterOpen"></a>|Engage the relay to open the shutter. This action can be requested at any time. ShutterOpen\<x><a id="ShutterOpen"></a>|Engage the relay to open the shutter. This action can be requested at any time.
ShutterPosition\<x><a id="ShutterPosition"></a>|`0..100`<BR>`0` = Closed, `100` = Open<BR>If the shutter is inverted (e.g., if used with KNX), `100` = Closed, `0` = Open<BR>A shutter position change can be requested at any time. The shutter will stop and revert or update to the requested position. The shutter's actual position will be saved _**after**_ the movement is completed. In this case, the position will be restored during reboot. An interruption during shutter movement (e.g., a device restart) will lose the current position. ShutterPosition\<x><a id="ShutterPosition"></a>|`0..100`<BR>`0` = Closed, `100` = Open<BR>If the shutter is inverted (e.g., if used with KNX), `100` = Closed, `0` = Open<BR>A shutter position change can be requested at any time. The shutter will stop and revert or update to the requested position. The shutter's actual position will be saved _**after**_ the movement is completed. In this case, the position will be restored during reboot. An interruption during shutter movement (e.g., a device restart) will lose the current position.